245c87b8263142c4230974f9fb0151ee2f583aa1
3 * Default values for MediaWiki configuration settings.
9 * To customize your installation, edit "LocalSettings.php". If you make
10 * changes here, they will be lost on next upgrade of MediaWiki!
12 * In this file, variables whose default values depend on other
13 * variables are set to false. The actual default value of these variables
14 * will only be set in Setup.php, taking into account any custom settings
15 * performed in LocalSettings.php.
17 * Documentation is in the source and on:
18 * https://www.mediawiki.org/wiki/Manual:Configuration_settings
20 * @warning Note: this (and other things) will break if the autoloader is not
21 * enabled. Please include includes/AutoLoader.php before including this file.
23 * This program is free software; you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation; either version 2 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License along
34 * with this program; if not, write to the Free Software Foundation, Inc.,
35 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
36 * http://www.gnu.org/copyleft/gpl.html
42 * @defgroup Globalsettings Global settings
46 * @cond file_level_code
47 * This is not a valid entry point, perform no further processing unless
48 * MEDIAWIKI is defined
50 if ( !defined( 'MEDIAWIKI' ) ) {
51 echo "This file is part of MediaWiki and is not a valid entry point\n";
56 * wgConf hold the site configuration.
57 * Not used for much in a default install.
60 $wgConf = new SiteConfiguration
;
63 * Registry of factory functions to create config objects:
64 * The 'main' key must be set, and the value should be a valid
68 $wgConfigRegistry = array(
69 'main' => 'GlobalVarConfig::newInstance'
73 * MediaWiki version number
76 $wgVersion = '1.24alpha';
79 * Name of the site. It must be changed in LocalSettings.php
81 $wgSitename = 'MediaWiki';
88 * $wgServer = 'http://example.com';
91 * This is usually detected correctly by MediaWiki. If MediaWiki detects the
92 * wrong server, it will redirect incorrectly after you save a page. In that
93 * case, set this variable to fix it.
95 * If you want to use protocol-relative URLs on your wiki, set this to a
96 * protocol-relative URL like '//example.com' and set $wgCanonicalServer
97 * to a fully qualified URL.
99 $wgServer = WebRequest
::detectServer();
102 * Canonical URL of the server, to use in IRC feeds and notification e-mails.
103 * Must be fully qualified, even if $wgServer is protocol-relative.
105 * Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.
108 $wgCanonicalServer = false;
111 * Server name. This is automatically computed by parsing the bare
112 * hostname out of $wgCanonicalServer. It should not be customized.
115 $wgServerName = false;
117 /************************************************************************//**
118 * @name Script path settings
123 * The path we should point to.
124 * It might be a virtual path in case with use apache mod_rewrite for example.
126 * This *needs* to be set correctly.
128 * Other paths will be set to defaults based on it unless they are directly
129 * set in LocalSettings.php
131 $wgScriptPath = '/wiki';
134 * Whether to support URLs like index.php/Page_title These often break when PHP
135 * is set up in CGI mode. PATH_INFO *may* be correct if cgi.fix_pathinfo is set,
136 * but then again it may not; lighttpd converts incoming path data to lowercase
137 * on systems with case-insensitive filesystems, and there have been reports of
138 * problems on Apache as well.
140 * To be safe we'll continue to keep it off by default.
142 * Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly
143 * incorrect garbage, or to true if it is really correct.
145 * The default $wgArticlePath will be set based on this value at runtime, but if
146 * you have customized it, having this incorrectly set to true can cause
147 * redirect loops when "pretty URLs" are used.
150 $wgUsePathInfo = ( strpos( PHP_SAPI
, 'cgi' ) === false ) &&
151 ( strpos( PHP_SAPI
, 'apache2filter' ) === false ) &&
152 ( strpos( PHP_SAPI
, 'isapi' ) === false );
155 * The extension to append to script names by default. This can either be .php
158 * Some hosting providers use PHP 4 for *.php files, and PHP 5 for *.php5. This
159 * variable is provided to support those providers.
162 $wgScriptExtension = '.php';
166 /************************************************************************//**
167 * @name URLs and file paths
169 * These various web and file path variables are set to their defaults
170 * in Setup.php if they are not explicitly set from LocalSettings.php.
172 * These will relatively rarely need to be set manually, unless you are
173 * splitting style sheets or images outside the main document root.
175 * In this section, a "path" is usually a host-relative URL, i.e. a URL without
176 * the host part, that starts with a slash. In most cases a full URL is also
177 * acceptable. A "directory" is a local file path.
179 * In both paths and directories, trailing slashes should not be included.
185 * The URL path to index.php.
187 * Defaults to "{$wgScriptPath}/index{$wgScriptExtension}".
192 * The URL path to load.php.
194 * Defaults to "{$wgScriptPath}/load{$wgScriptExtension}".
197 $wgLoadScript = false;
200 * The URL path of the skins directory.
201 * Defaults to "{$wgScriptPath}/skins".
204 $wgStylePath = false;
205 $wgStyleSheetPath = &$wgStylePath;
208 * The URL path of the skins directory. Should not point to an external domain.
209 * Defaults to "{$wgScriptPath}/skins".
212 $wgLocalStylePath = false;
215 * The URL path of the extensions directory.
216 * Defaults to "{$wgScriptPath}/extensions".
219 $wgExtensionAssetsPath = false;
222 * Filesystem stylesheets directory.
223 * Defaults to "{$IP}/skins".
226 $wgStyleDirectory = false;
229 * The URL path for primary article page views. This path should contain $1,
230 * which is replaced by the article title.
232 * Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1",
233 * depending on $wgUsePathInfo.
235 $wgArticlePath = false;
238 * The URL path for the images directory.
239 * Defaults to "{$wgScriptPath}/images".
241 $wgUploadPath = false;
244 * The filesystem path of the images directory. Defaults to "{$IP}/images".
246 $wgUploadDirectory = false;
249 * Directory where the cached page will be saved.
250 * Defaults to "{$wgUploadDirectory}/cache".
252 $wgFileCacheDirectory = false;
255 * The URL path of the wiki logo. The logo size should be 135x135 pixels.
256 * Defaults to "{$wgStylePath}/common/images/wiki.png".
261 * The URL path of the shortcut icon.
264 $wgFavicon = '/favicon.ico';
267 * The URL path of the icon for iPhone and iPod Touch web app bookmarks.
268 * Defaults to no icon.
271 $wgAppleTouchIcon = false;
274 * The local filesystem path to a temporary directory. This is not required to
277 * When this setting is set to false, its value will be set through a call
278 * to wfTempDir(). See that methods implementation for the actual detection
281 * Developers should use the global function wfTempDir() instead of this
285 * @note Default changed to false in MediaWiki 1.20.
287 $wgTmpDirectory = false;
290 * If set, this URL is added to the start of $wgUploadPath to form a complete
294 $wgUploadBaseUrl = '';
297 * To enable remote on-demand scaling, set this to the thumbnail base URL.
298 * Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg
299 * where 'e6' are the first two characters of the MD5 hash of the file name.
300 * If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.
303 $wgUploadStashScalerBaseUrl = false;
306 * To set 'pretty' URL paths for actions other than
307 * plain page views, add to this array.
310 * Set pretty URL for the edit action:
312 * 'edit' => "$wgScriptPath/edit/$1"
315 * There must be an appropriate script or rewrite rule in place to handle these
319 $wgActionPaths = array();
323 /************************************************************************//**
324 * @name Files and file uploads
329 * Uploads have to be specially set up to be secure
331 $wgEnableUploads = false;
334 * The maximum age of temporary (incomplete) uploaded files
336 $wgUploadStashMaxAge = 6 * 3600; // 6 hours
339 * Allows to move images and other media files
341 $wgAllowImageMoving = true;
344 * Enable deferred upload tasks that use the job queue.
345 * Only enable this if job runners are set up for both the
346 * 'AssembleUploadChunks' and 'PublishStashedFile' job types.
348 * @note If you use suhosin, this setting is incompatible with
349 * suhosin.session.encrypt.
351 $wgEnableAsyncUploads = false;
354 * These are additional characters that should be replaced with '-' in filenames
356 $wgIllegalFileChars = ":";
359 * What directory to place deleted uploads in.
360 * Defaults to "{$wgUploadDirectory}/deleted".
362 $wgDeletedDirectory = false;
365 * Set this to true if you use img_auth and want the user to see details on why access failed.
367 $wgImgAuthDetails = false;
370 * Map of relative URL directories to match to internal mwstore:// base storage paths.
371 * For img_auth.php requests, everything after "img_auth.php/" is checked to see
372 * if starts with any of the prefixes defined here. The prefixes should not overlap.
373 * The prefix that matches has a corresponding storage path, which the rest of the URL
374 * is assumed to be relative to. The file at that path (or a 404) is send to the client.
377 * $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/';
378 * The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/".
379 * The name "local-fs" should correspond by name to an entry in $wgFileBackends.
381 * @see $wgFileBackends
383 $wgImgAuthUrlPathMap = array();
386 * File repository structures
388 * $wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is
389 * an array of such structures. Each repository structure is an associative
390 * array of properties configuring the repository.
392 * Properties required for all repos:
393 * - class The class name for the repository. May come from the core or an extension.
394 * The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
395 * FSRepo is also supported for backwards compatibility.
397 * - name A unique name for the repository (but $wgLocalFileRepo should be 'local').
398 * The name should consist of alpha-numeric characters.
399 * - backend A file backend name (see $wgFileBackends).
401 * For most core repos:
402 * - zones Associative array of zone names that each map to an array with:
403 * container : backend container name the zone is in
404 * directory : root path within container for the zone
405 * url : base URL to the root of the zone
406 * urlsByExt : map of file extension types to base URLs
407 * (useful for using a different cache for videos)
408 * Zones default to using "<repo name>-<zone name>" as the container name
409 * and default to using the container root as the zone's root directory.
410 * Nesting of zone locations within other zones should be avoided.
411 * - url Public zone URL. The 'zones' settings take precedence.
412 * - hashLevels The number of directory levels for hash-based division of files
413 * - thumbScriptUrl The URL for thumb.php (optional, not recommended)
414 * - transformVia404 Whether to skip media file transformation on parse and rely on a 404
416 * - initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
417 * determines whether filenames implicitly start with a capital letter.
418 * The current implementation may give incorrect description page links
419 * when the local $wgCapitalLinks and initialCapital are mismatched.
420 * - pathDisclosureProtection
421 * May be 'paranoid' to remove all parameters from error messages, 'none' to
422 * leave the paths in unchanged, or 'simple' to replace paths with
423 * placeholders. Default for LocalRepo is 'simple'.
424 * - fileMode This allows wikis to set the file mode when uploading/moving files. Default
426 * - directory The local filesystem directory where public files are stored. Not used for
428 * - thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
429 * - thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
430 * - isPrivate Set this if measures should always be taken to keep the files private.
431 * One should not trust this to assure that the files are not web readable;
432 * the server configuration should be done manually depending on the backend.
434 * These settings describe a foreign MediaWiki installation. They are optional, and will be ignored
435 * for local repositories:
436 * - descBaseUrl URL of image description pages, e.g. http://en.wikipedia.org/wiki/File:
437 * - scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.
438 * http://en.wikipedia.org/w
439 * - scriptExtension Script extension of the MediaWiki installation, equivalent to
440 * $wgScriptExtension, e.g. .php5 defaults to .php
442 * - articleUrl Equivalent to $wgArticlePath, e.g. http://en.wikipedia.org/wiki/$1
443 * - fetchDescription Fetch the text of the remote file description page. Equivalent to
444 * $wgFetchCommonsDescriptions.
445 * - abbrvThreshold File names over this size will use the short form of thumbnail names.
446 * Short thumbnail names only have the width, parameters, and the extension.
449 * - dbType, dbServer, dbUser, dbPassword, dbName, dbFlags
450 * equivalent to the corresponding member of $wgDBservers
451 * - tablePrefix Table prefix, the foreign wiki's $wgDBprefix
452 * - hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc
455 * - apibase Use for the foreign API's URL
456 * - apiThumbCacheExpiry How long to locally cache thumbs for
458 * If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values.
459 * Otherwise, set $wgLocalFileRepo to a repository structure as described above.
460 * If you set $wgUseInstantCommons to true, it will add an entry for Commons.
461 * If you set $wgForeignFileRepos to an array of repository structures, those will
462 * be searched after the local file repo.
463 * Otherwise, you will only have access to local media files.
465 * @see Setup.php for an example usage and default initialization.
467 $wgLocalFileRepo = false;
470 * @see $wgLocalFileRepo
472 $wgForeignFileRepos = array();
475 * Use Commons as a remote file repository. Essentially a wrapper, when this
476 * is enabled $wgForeignFileRepos will point at Commons with a set of default
479 $wgUseInstantCommons = false;
482 * File backend structure configuration.
484 * This is an array of file backend configuration arrays.
485 * Each backend configuration has the following parameters:
486 * - 'name' : A unique name for the backend
487 * - 'class' : The file backend class to use
488 * - 'wikiId' : A unique string that identifies the wiki (container prefix)
489 * - 'lockManager' : The name of a lock manager (see $wgLockManagers)
491 * See FileBackend::__construct() for more details.
492 * Additional parameters are specific to the file backend class used.
493 * These settings should be global to all wikis when possible.
495 * There are two particularly important aspects about each backend:
496 * - a) Whether it is fully qualified or wiki-relative.
497 * By default, the paths of files are relative to the current wiki,
498 * which works via prefixing them with the current wiki ID when accessed.
499 * Setting 'wikiId' forces the backend to be fully qualified by prefixing
500 * all paths with the specified value instead. This can be useful if
501 * multiple wikis need to share the same data. Note that 'name' is *not*
502 * part of any prefix and thus should not be relied upon for namespacing.
503 * - b) Whether it is only defined for some wikis or is defined on all
504 * wikis in the wiki farm. Defining a backend globally is useful
505 * if multiple wikis need to share the same data.
506 * One should be aware of these aspects when configuring a backend for use with
507 * any basic feature or plugin. For example, suppose an extension stores data for
508 * different wikis in different directories and sometimes needs to access data from
509 * a foreign wiki's directory in order to render a page on given wiki. The extension
510 * would need a fully qualified backend that is defined on all wikis in the wiki farm.
512 $wgFileBackends = array();
515 * Array of configuration arrays for each lock manager.
516 * Each backend configuration has the following parameters:
517 * - 'name' : A unique name for the lock manager
518 * - 'class' : The lock manger class to use
520 * See LockManager::__construct() for more details.
521 * Additional parameters are specific to the lock manager class used.
522 * These settings should be global to all wikis.
524 $wgLockManagers = array();
527 * Show Exif data, on by default if available.
528 * Requires PHP's Exif extension: http://www.php.net/manual/en/ref.exif.php
530 * @note FOR WINDOWS USERS:
531 * To enable Exif functions, add the following lines to the "Windows
532 * extensions" section of php.ini:
534 * extension=extensions/php_mbstring.dll
535 * extension=extensions/php_exif.dll
538 $wgShowEXIF = function_exists( 'exif_read_data' );
541 * If to automatically update the img_metadata field
542 * if the metadata field is outdated but compatible with the current version.
545 $wgUpdateCompatibleMetadata = false;
548 * If you operate multiple wikis, you can define a shared upload path here.
549 * Uploads to this wiki will NOT be put there - they will be put into
550 * $wgUploadDirectory.
551 * If $wgUseSharedUploads is set, the wiki will look in the shared repository if
552 * no file of the given name is found in the local repository (for [[File:..]],
553 * [[Media:..]] links). Thumbnails will also be looked for and generated in this
556 * Note that these configuration settings can now be defined on a per-
557 * repository basis for an arbitrary number of file repositories, using the
558 * $wgForeignFileRepos variable.
560 $wgUseSharedUploads = false;
563 * Full path on the web server where shared uploads can be found
565 $wgSharedUploadPath = "http://commons.wikimedia.org/shared/images";
568 * Fetch commons image description pages and display them on the local wiki?
570 $wgFetchCommonsDescriptions = false;
573 * Path on the file system where shared uploads can be found.
575 $wgSharedUploadDirectory = "/var/www/wiki3/images";
578 * DB name with metadata about shared directory.
579 * Set this to false if the uploads do not come from a wiki.
581 $wgSharedUploadDBname = false;
584 * Optional table prefix used in database.
586 $wgSharedUploadDBprefix = '';
589 * Cache shared metadata in memcached.
590 * Don't do this if the commons wiki is in a different memcached domain
592 $wgCacheSharedUploads = true;
595 * Allow for upload to be copied from an URL.
596 * The timeout for copy uploads is set by $wgCopyUploadTimeout.
597 * You have to assign the user right 'upload_by_url' to a user group, to use this.
599 $wgAllowCopyUploads = false;
602 * Allow asynchronous copy uploads.
603 * This feature is experimental and broken as of r81612.
605 $wgAllowAsyncCopyUploads = false;
608 * A list of domains copy uploads can come from
612 $wgCopyUploadsDomains = array();
615 * Enable copy uploads from Special:Upload. $wgAllowCopyUploads must also be
616 * true. If $wgAllowCopyUploads is true, but this is false, you will only be
617 * able to perform copy uploads from the API or extensions (e.g. UploadWizard).
619 $wgCopyUploadsFromSpecialUpload = false;
622 * Proxy to use for copy upload requests.
625 $wgCopyUploadProxy = false;
628 * Different timeout for upload by url
629 * This could be useful since when fetching large files, you may want a
630 * timeout longer than the default $wgHTTPTimeout. False means fallback
635 $wgCopyUploadTimeout = false;
638 * Different timeout for upload by url when run as a background job
639 * This could be useful since when fetching large files via job queue,
640 * you may want a different timeout, especially because there is no
641 * http request being kept alive.
643 * false means fallback to $wgCopyUploadTimeout.
646 $wgCopyUploadAsyncTimeout = false;
649 * Max size for uploads, in bytes. If not set to an array, applies to all
650 * uploads. If set to an array, per upload type maximums can be set, using the
651 * file and url keys. If the * key is set this value will be used as maximum
652 * for non-specified types.
656 * $wgMaxUploadSize = array(
658 * 'url' => 500 * 1024,
661 * Sets the maximum for all uploads to 250 kB except for upload-by-url, which
662 * will have a maximum of 500 kB.
664 $wgMaxUploadSize = 1024 * 1024 * 100; # 100MB
667 * Point the upload navigation link to an external URL
668 * Useful if you want to use a shared repository by default
669 * without disabling local uploads (use $wgEnableUploads = false for that).
673 * $wgUploadNavigationUrl = 'http://commons.wikimedia.org/wiki/Special:Upload';
676 $wgUploadNavigationUrl = false;
679 * Point the upload link for missing files to an external URL, as with
680 * $wgUploadNavigationUrl. The URL will get "(?|&)wpDestFile=<filename>"
681 * appended to it as appropriate.
683 $wgUploadMissingFileUrl = false;
686 * Give a path here to use thumb.php for thumbnail generation on client
687 * request, instead of generating them on render and outputting a static URL.
688 * This is necessary if some of your apache servers don't have read/write
689 * access to the thumbnail path.
693 * $wgThumbnailScriptPath = "{$wgScriptPath}/thumb{$wgScriptExtension}";
696 $wgThumbnailScriptPath = false;
699 * @see $wgThumbnailScriptPath
701 $wgSharedThumbnailScriptPath = false;
704 * Set this to false if you do not want MediaWiki to divide your images
705 * directory into many subdirectories, for improved performance.
707 * It's almost always good to leave this enabled. In previous versions of
708 * MediaWiki, some users set this to false to allow images to be added to the
709 * wiki by simply copying them into $wgUploadDirectory and then running
710 * maintenance/rebuildImages.php to register them in the database. This is no
711 * longer recommended, use maintenance/importImages.php instead.
713 * @note That this variable may be ignored if $wgLocalFileRepo is set.
714 * @todo Deprecate the setting and ultimately remove it from Core.
716 $wgHashedUploadDirectory = true;
719 * Set the following to false especially if you have a set of files that need to
720 * be accessible by all wikis, and you do not want to use the hash (path/a/aa/)
723 $wgHashedSharedUploadDirectory = true;
726 * Base URL for a repository wiki. Leave this blank if uploads are just stored
727 * in a shared directory and not meant to be accessible through a separate wiki.
728 * Otherwise the image description pages on the local wiki will link to the
729 * image description page on this wiki.
731 * Please specify the namespace, as in the example below.
733 $wgRepositoryBaseUrl = "http://commons.wikimedia.org/wiki/File:";
736 * This is the list of preferred extensions for uploading files. Uploading files
737 * with extensions not in this list will trigger a warning.
739 * @warning If you add any OpenOffice or Microsoft Office file formats here,
740 * such as odt or doc, and untrusted users are allowed to upload files, then
741 * your wiki will be vulnerable to cross-site request forgery (CSRF).
743 $wgFileExtensions = array( 'png', 'gif', 'jpg', 'jpeg' );
746 * Files with these extensions will never be allowed as uploads.
747 * An array of file extensions to blacklist. You should append to this array
748 * if you want to blacklist additional files.
750 $wgFileBlacklist = array(
751 # HTML may contain cookie-stealing JavaScript and web bugs
752 'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
753 # PHP scripts may execute arbitrary code on the server
754 'php', 'phtml', 'php3', 'php4', 'php5', 'phps',
755 # Other types that may be interpreted by some servers
756 'shtml', 'jhtml', 'pl', 'py', 'cgi',
757 # May contain harmful executables for Windows victims
758 'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' );
761 * Files with these MIME types will never be allowed as uploads
762 * if $wgVerifyMimeType is enabled.
764 $wgMimeTypeBlacklist = array(
765 # HTML may contain cookie-stealing JavaScript and web bugs
766 'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
767 # PHP scripts may execute arbitrary code on the server
768 'application/x-php', 'text/x-php',
769 # Other types that may be interpreted by some servers
770 'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
771 # Client-side hazards on Internet Explorer
772 'text/scriptlet', 'application/x-msdownload',
773 # Windows metafile, client-side vulnerability on some systems
774 'application/x-msmetafile',
778 * Allow Java archive uploads.
779 * This is not recommended for public wikis since a maliciously-constructed
780 * applet running on the same domain as the wiki can steal the user's cookies.
782 $wgAllowJavaUploads = false;
785 * This is a flag to determine whether or not to check file extensions on upload.
787 * @warning Setting this to false is insecure for public wikis.
789 $wgCheckFileExtensions = true;
792 * If this is turned off, users may override the warning for files not covered
793 * by $wgFileExtensions.
795 * @warning Setting this to false is insecure for public wikis.
797 $wgStrictFileExtensions = true;
800 * Setting this to true will disable the upload system's checks for HTML/JavaScript.
802 * @warning THIS IS VERY DANGEROUS on a publicly editable site, so USE
803 * $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust
805 $wgDisableUploadScriptChecks = false;
808 * Warn if uploaded files are larger than this (in bytes), or false to disable
810 $wgUploadSizeWarning = false;
813 * list of trusted media-types and MIME types.
814 * Use the MEDIATYPE_xxx constants to represent media types.
815 * This list is used by File::isSafeFile
817 * Types not listed here will have a warning about unsafe content
818 * displayed on the images description page. It would also be possible
819 * to use this for further restrictions, like disabling direct
820 * [[media:...]] links for non-trusted formats.
822 $wgTrustedMediaFormats = array(
823 MEDIATYPE_BITMAP
, //all bitmap formats
824 MEDIATYPE_AUDIO
, //all audio formats
825 MEDIATYPE_VIDEO
, //all plain video formats
826 "image/svg+xml", //svg (only needed if inline rendering of svg is not supported)
827 "application/pdf", //PDF files
828 #"application/x-shockwave-flash", //flash/shockwave movie
832 * Plugins for media file type handling.
833 * Each entry in the array maps a MIME type to a class name
835 $wgMediaHandlers = array(
836 'image/jpeg' => 'JpegHandler',
837 'image/png' => 'PNGHandler',
838 'image/gif' => 'GIFHandler',
839 'image/tiff' => 'TiffHandler',
840 'image/x-ms-bmp' => 'BmpHandler',
841 'image/x-bmp' => 'BmpHandler',
842 'image/x-xcf' => 'XCFHandler',
843 'image/svg+xml' => 'SvgHandler', // official
844 'image/svg' => 'SvgHandler', // compat
845 'image/vnd.djvu' => 'DjVuHandler', // official
846 'image/x.djvu' => 'DjVuHandler', // compat
847 'image/x-djvu' => 'DjVuHandler', // compat
851 * Plugins for page content model handling.
852 * Each entry in the array maps a model id to a class name.
856 $wgContentHandlers = array(
858 CONTENT_MODEL_WIKITEXT
=> 'WikitextContentHandler',
859 // dumb version, no syntax highlighting
860 CONTENT_MODEL_JAVASCRIPT
=> 'JavaScriptContentHandler',
861 // simple implementation, for use by extensions, etc.
862 CONTENT_MODEL_JSON
=> 'JSONContentHandler',
863 // dumb version, no syntax highlighting
864 CONTENT_MODEL_CSS
=> 'CssContentHandler',
865 // plain text, for use by extensions, etc.
866 CONTENT_MODEL_TEXT
=> 'TextContentHandler',
870 * Whether to enable server-side image thumbnailing. If false, images will
871 * always be sent to the client in full resolution, with appropriate width= and
872 * height= attributes on the <img> tag for the client to do its own scaling.
874 $wgUseImageResize = true;
877 * Resizing can be done using PHP's internal image libraries or using
878 * ImageMagick or another third-party converter, e.g. GraphicMagick.
879 * These support more file formats than PHP, which only supports PNG,
880 * GIF, JPG, XBM and WBMP.
882 * Use Image Magick instead of PHP builtin functions.
884 $wgUseImageMagick = false;
887 * The convert command shipped with ImageMagick
889 $wgImageMagickConvertCommand = '/usr/bin/convert';
892 * Sharpening parameter to ImageMagick
894 $wgSharpenParameter = '0x0.4';
897 * Reduction in linear dimensions below which sharpening will be enabled
899 $wgSharpenReductionThreshold = 0.85;
902 * Temporary directory used for ImageMagick. The directory must exist. Leave
903 * this set to false to let ImageMagick decide for itself.
905 $wgImageMagickTempDir = false;
908 * Use another resizing converter, e.g. GraphicMagick
909 * %s will be replaced with the source path, %d with the destination
910 * %w and %h will be replaced with the width and height.
912 * @par Example for GraphicMagick:
914 * $wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"
917 * Leave as false to skip this.
919 $wgCustomConvertCommand = false;
922 * used for lossless jpeg rotation
926 $wgJpegTran = '/usr/bin/jpegtran';
929 * Some tests and extensions use exiv2 to manipulate the Exif metadata in some
932 $wgExiv2Command = '/usr/bin/exiv2';
935 * Scalable Vector Graphics (SVG) may be uploaded as images.
936 * Since SVG support is not yet standard in browsers, it is
937 * necessary to rasterize SVGs to PNG as a fallback format.
939 * An external program is required to perform this conversion.
940 * If set to an array, the first item is a PHP callable and any further items
941 * are passed as parameters after $srcPath, $dstPath, $width, $height
943 $wgSVGConverters = array(
944 'ImageMagick' => '$path/convert -background white -thumbnail $widthx$height\! $input PNG:$output',
945 'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
946 'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
947 'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
949 'rsvg' => '$path/rsvg -w $width -h $height $input $output',
950 'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
951 'ImagickExt' => array( 'SvgHandler::rasterizeImagickExt' ),
955 * Pick a converter defined in $wgSVGConverters
957 $wgSVGConverter = 'ImageMagick';
960 * If not in the executable PATH, specify the SVG converter path.
962 $wgSVGConverterPath = '';
965 * Don't scale a SVG larger than this
967 $wgSVGMaxSize = 2048;
970 * Don't read SVG metadata beyond this point.
971 * Default is 1024*256 bytes
973 $wgSVGMetadataCutoff = 262144;
976 * Disallow <title> element in SVG files.
978 * MediaWiki will reject HTMLesque tags in uploaded files due to idiotic
979 * browsers which can not perform basic stuff like MIME detection and which are
980 * vulnerable to further idiots uploading crap files as images.
982 * When this directive is on, "<title>" will be allowed in files with an
983 * "image/svg+xml" MIME type. You should leave this disabled if your web server
984 * is misconfigured and doesn't send appropriate MIME types for SVG images.
986 $wgAllowTitlesInSVG = false;
989 * The maximum number of pixels a source image can have if it is to be scaled
990 * down by a scaler that requires the full source image to be decompressed
991 * and stored in decompressed form, before the thumbnail is generated.
993 * This provides a limit on memory usage for the decompression side of the
994 * image scaler. The limit is used when scaling PNGs with any of the
995 * built-in image scalers, such as ImageMagick or GD. It is ignored for
996 * JPEGs with ImageMagick, and when using the VipsScaler extension.
998 * The default is 50 MB if decompressed to RGBA form, which corresponds to
999 * 12.5 million pixels or 3500x3500.
1001 $wgMaxImageArea = 1.25e7
;
1004 * Force thumbnailing of animated GIFs above this size to a single
1005 * frame instead of an animated thumbnail. As of MW 1.17 this limit
1006 * is checked against the total size of all frames in the animation.
1007 * It probably makes sense to keep this equal to $wgMaxImageArea.
1009 $wgMaxAnimatedGifArea = 1.25e7
;
1012 * Browsers don't support TIFF inline generally...
1013 * For inline display, we need to convert to PNG or JPEG.
1014 * Note scaling should work with ImageMagick, but may not with GD scaling.
1018 * // PNG is lossless, but inefficient for photos
1019 * $wgTiffThumbnailType = array( 'png', 'image/png' );
1020 * // JPEG is good for photos, but has no transparency support. Bad for diagrams.
1021 * $wgTiffThumbnailType = array( 'jpg', 'image/jpeg' );
1024 $wgTiffThumbnailType = false;
1027 * If rendered thumbnail files are older than this timestamp, they
1028 * will be rerendered on demand as if the file didn't already exist.
1029 * Update if there is some need to force thumbs and SVG rasterizations
1030 * to rerender, such as fixes to rendering bugs.
1032 $wgThumbnailEpoch = '20030516000000';
1035 * Certain operations are avoided if there were too many recent failures,
1036 * for example, thumbnail generation. Bump this value to invalidate all
1037 * memory of failed operations and thus allow further attempts to resume.
1038 * This is useful when a cause for the failures has been found and fixed.
1040 $wgAttemptFailureEpoch = 1;
1043 * If set, inline scaled images will still produce "<img>" tags ready for
1044 * output instead of showing an error message.
1046 * This may be useful if errors are transitory, especially if the site
1047 * is configured to automatically render thumbnails on request.
1049 * On the other hand, it may obscure error conditions from debugging.
1050 * Enable the debug log or the 'thumbnail' log group to make sure errors
1051 * are logged to a file for review.
1053 $wgIgnoreImageErrors = false;
1056 * Allow thumbnail rendering on page view. If this is false, a valid
1057 * thumbnail URL is still output, but no file will be created at
1058 * the target location. This may save some time if you have a
1059 * thumb.php or 404 handler set up which is faster than the regular
1062 $wgGenerateThumbnailOnParse = true;
1065 * Show thumbnails for old images on the image description page
1067 $wgShowArchiveThumbnails = true;
1070 * If set to true, images that contain certain the exif orientation tag will
1071 * be rotated accordingly. If set to null, try to auto-detect whether a scaler
1072 * is available that can rotate.
1074 $wgEnableAutoRotation = null;
1077 * Internal name of virus scanner. This serves as a key to the
1078 * $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not
1079 * null, every file uploaded will be scanned for viruses.
1081 $wgAntivirus = null;
1084 * Configuration for different virus scanners. This an associative array of
1085 * associative arrays. It contains one setup array per known scanner type.
1086 * The entry is selected by $wgAntivirus, i.e.
1087 * valid values for $wgAntivirus are the keys defined in this array.
1089 * The configuration array for each scanner contains the following keys:
1090 * "command", "codemap", "messagepattern":
1092 * "command" is the full command to call the virus scanner - %f will be
1093 * replaced with the name of the file to scan. If not present, the filename
1094 * will be appended to the command. Note that this must be overwritten if the
1095 * scanner is not in the system path; in that case, please set
1096 * $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full
1099 * "codemap" is a mapping of exit code to return codes of the detectVirus
1100 * function in SpecialUpload.
1101 * - An exit code mapped to AV_SCAN_FAILED causes the function to consider
1102 * the scan to be failed. This will pass the file if $wgAntivirusRequired
1104 * - An exit code mapped to AV_SCAN_ABORTED causes the function to consider
1105 * the file to have an unsupported format, which is probably immune to
1106 * viruses. This causes the file to pass.
1107 * - An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning
1108 * no virus was found.
1109 * - All other codes (like AV_VIRUS_FOUND) will cause the function to report
1111 * - You may use "*" as a key in the array to catch all exit codes not mapped otherwise.
1113 * "messagepattern" is a perl regular expression to extract the meaningful part of the scanners
1114 * output. The relevant part should be matched as group one (\1).
1115 * If not defined or the pattern does not match, the full message is shown to the user.
1117 $wgAntivirusSetup = array(
1121 'command' => 'clamscan --no-summary ',
1123 "0" => AV_NO_VIRUS
, # no virus
1124 "1" => AV_VIRUS_FOUND
, # virus found
1125 "52" => AV_SCAN_ABORTED
, # unsupported file format (probably immune)
1126 "*" => AV_SCAN_FAILED
, # else scan failed
1128 'messagepattern' => '/.*?:(.*)/sim',
1133 * Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
1135 $wgAntivirusRequired = true;
1138 * Determines if the MIME type of uploaded files should be checked
1140 $wgVerifyMimeType = true;
1143 * Sets the MIME type definition file to use by MimeMagic.php.
1144 * Set to null, to use built-in defaults only.
1145 * example: $wgMimeTypeFile = '/etc/mime.types';
1147 $wgMimeTypeFile = 'includes/mime.types';
1150 * Sets the MIME type info file to use by MimeMagic.php.
1151 * Set to null, to use built-in defaults only.
1153 $wgMimeInfoFile = 'includes/mime.info';
1156 * Sets an external MIME detector program. The command must print only
1157 * the MIME type to standard output.
1158 * The name of the file to process will be appended to the command given here.
1159 * If not set or NULL, mime_content_type will be used if available.
1163 * #$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)
1166 $wgMimeDetectorCommand = null;
1169 * Switch for trivial MIME detection. Used by thumb.php to disable all fancy
1170 * things, because only a few types of images are needed and file extensions
1173 $wgTrivialMimeDetection = false;
1176 * Additional XML types we can allow via MIME-detection.
1177 * array = ( 'rootElement' => 'associatedMimeType' )
1179 $wgXMLMimeTypes = array(
1180 'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
1181 'svg' => 'image/svg+xml',
1182 'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
1183 'http://www.w3.org/1999/xhtml:html' => 'text/html', // application/xhtml+xml?
1184 'html' => 'text/html', // application/xhtml+xml?
1188 * Limit images on image description pages to a user-selectable limit. In order
1189 * to reduce disk usage, limits can only be selected from a list.
1190 * The user preference is saved as an array offset in the database, by default
1191 * the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you
1192 * change it if you alter the array (see bug 8858).
1193 * This is the list of settings the user can choose from:
1195 $wgImageLimits = array(
1204 * Adjust thumbnails on image pages according to a user setting. In order to
1205 * reduce disk usage, the values can only be selected from a list. This is the
1206 * list of settings the user can choose from:
1208 $wgThumbLimits = array(
1218 * When defined, is an array of image widths used as buckets for thumbnail generation.
1219 * The goal is to save resources by generating thumbnails based on reference buckets instead of
1220 * always using the original. This will incur a speed gain but cause a quality loss.
1222 * The buckets generation is chained, with each bucket generated based on the above bucket
1223 * when possible. File handlers have to opt into using that feature. For now only BitmapHandler
1226 $wgThumbnailBuckets = null;
1229 * When using thumbnail buckets as defined above, this sets the minimum distance to the bucket
1230 * above the requested size. The distance represents how many extra pixels of width the bucket
1231 * needs in order to be used as the reference for a given thumbnail. For example, with the
1232 * following buckets:
1234 * $wgThumbnailBuckets = array ( 128, 256, 512 );
1236 * and a distance of 50:
1238 * $wgThumbnailMinimumBucketDistance = 50;
1240 * If we want to render a thumbnail of width 220px, the 512px bucket will be used,
1241 * because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
1243 $wgThumbnailMinimumBucketDistance = 50;
1246 * When defined, is an array of thumbnail widths to be rendered at upload time. The idea is to
1247 * prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which
1248 * has a performance impact for the first client to view a certain size.
1250 * This obviously means that more disk space is needed per upload upfront.
1255 $wgUploadThumbnailRenderMap = array();
1258 * The method through which the thumbnails will be prerendered for the entries in
1259 * $wgUploadThumbnailRenderMap
1261 * The method can be either "http" or "jobqueue". The former uses an http request to hit the
1263 * This method only works if thumbnails are configured to be rendered by a 404 handler. The latter
1264 * option uses the job queue to render the thumbnail.
1268 $wgUploadThumbnailRenderMethod = 'jobqueue';
1271 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
1275 $wgUploadThumbnailRenderHttpCustomHost = false;
1278 * When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the
1283 $wgUploadThumbnailRenderHttpCustomDomain = false;
1286 * Default parameters for the "<gallery>" tag
1288 $wgGalleryOptions = array(
1289 'imagesPerRow' => 0, // Default number of images per-row in the gallery. 0 -> Adapt to screensize
1290 'imageWidth' => 120, // Width of the cells containing images in galleries (in "px")
1291 'imageHeight' => 120, // Height of the cells containing images in galleries (in "px")
1292 'captionLength' => 25, // Length of caption to truncate (in characters)
1293 'showBytes' => true, // Show the filesize in bytes in categories
1294 'mode' => 'traditional',
1298 * Adjust width of upright images when parameter 'upright' is used
1299 * This allows a nicer look for upright images without the need to fix the width
1300 * by hardcoded px in wiki sourcecode.
1302 $wgThumbUpright = 0.75;
1305 * Default value for chmoding of new directories.
1307 $wgDirectoryMode = 0777;
1310 * Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
1312 * This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480
1313 * thumbnails, output via data-src-1-5 and data-src-2-0. Runtime JavaScript switches the
1314 * images in after loading the original low-resolution versions depending on the reported
1315 * window.devicePixelRatio.
1317 $wgResponsiveImages = true;
1320 * @name DJVU settings
1325 * Path of the djvudump executable
1326 * Enable this and $wgDjvuRenderer to enable djvu rendering
1327 * example: $wgDjvuDump = 'djvudump';
1332 * Path of the ddjvu DJVU renderer
1333 * Enable this and $wgDjvuDump to enable djvu rendering
1334 * example: $wgDjvuRenderer = 'ddjvu';
1336 $wgDjvuRenderer = null;
1339 * Path of the djvutxt DJVU text extraction utility
1340 * Enable this and $wgDjvuDump to enable text layer extraction from djvu files
1341 * example: $wgDjvuTxt = 'djvutxt';
1346 * Path of the djvutoxml executable
1347 * This works like djvudump except much, much slower as of version 3.5.
1349 * For now we recommend you use djvudump instead. The djvuxml output is
1350 * probably more stable, so we'll switch back to it as soon as they fix
1351 * the efficiency problem.
1352 * http://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583
1356 * $wgDjvuToXML = 'djvutoxml';
1359 $wgDjvuToXML = null;
1362 * Shell command for the DJVU post processor
1363 * Default: pnmtojpeg, since ddjvu generates ppm output
1364 * Set this to false to output the ppm file directly.
1366 $wgDjvuPostProcessor = 'pnmtojpeg';
1369 * File extension for the DJVU post processor output
1371 $wgDjvuOutputExtension = 'jpg';
1373 /** @} */ # end of DJvu }
1375 /** @} */ # end of file uploads }
1377 /************************************************************************//**
1378 * @name Email settings
1384 * Site admin email address.
1386 * Defaults to "wikiadmin@{$wgServerName}".
1388 $wgEmergencyContact = false;
1391 * Password reminder email address.
1393 * The address we should use as sender when a user is requesting his password.
1395 * Defaults to "apache@{$wgServerName}".
1397 $wgPasswordSender = false;
1400 * Password reminder name
1402 * @deprecated since 1.23; use the system message 'emailsender' instead.
1404 $wgPasswordSenderName = 'MediaWiki Mail';
1407 * Dummy address which should be accepted during mail send action.
1408 * It might be necessary to adapt the address or to set it equal
1409 * to the $wgEmergencyContact address.
1411 $wgNoReplyAddress = 'reply@not.possible';
1414 * Set to true to enable the e-mail basic features:
1415 * Password reminders, etc. If sending e-mail on your
1416 * server doesn't work, you might want to disable this.
1418 $wgEnableEmail = true;
1421 * Set to true to enable user-to-user e-mail.
1422 * This can potentially be abused, as it's hard to track.
1424 $wgEnableUserEmail = true;
1427 * Set to true to put the sending user's email in a Reply-To header
1428 * instead of From. ($wgEmergencyContact will be used as From.)
1430 * Some mailers (eg sSMTP) set the SMTP envelope sender to the From value,
1431 * which can cause problems with SPF validation and leak recipient addresses
1432 * when bounces are sent to the sender.
1434 $wgUserEmailUseReplyTo = false;
1437 * Minimum time, in hours, which must elapse between password reminder
1438 * emails for a given account. This is to prevent abuse by mail flooding.
1440 $wgPasswordReminderResendTime = 24;
1443 * The time, in seconds, when an emailed temporary password expires.
1445 $wgNewPasswordExpiry = 3600 * 24 * 7;
1448 * The time, in seconds, when an email confirmation email expires
1450 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60;
1453 * The number of days that a user's password is good for. After this number of days, the
1454 * user will be asked to reset their password. Set to false to disable password expiration.
1456 $wgPasswordExpirationDays = false;
1459 * If a user's password is expired, the number of seconds when they can still login,
1460 * and cancel their password change, but are sent to the password change form on each login.
1462 $wgPasswordExpireGrace = 3600 * 24 * 7; // 7 days
1467 * For using a direct (authenticated) SMTP server connection.
1468 * Default to false or fill an array :
1472 * 'host' => 'SMTP domain',
1473 * 'IDHost' => 'domain for MessageID',
1475 * 'auth' => [true|false],
1476 * 'username' => [SMTP username],
1477 * 'password' => [SMTP password],
1484 * Additional email parameters, will be passed as the last argument to mail() call.
1485 * If using safe_mode this has no effect
1487 $wgAdditionalMailParams = null;
1490 * For parts of the system that have been updated to provide HTML email content, send
1491 * both text and HTML parts as the body of the email
1493 $wgAllowHTMLEmail = false;
1496 * True: from page editor if s/he opted-in. False: Enotif mails appear to come
1497 * from $wgEmergencyContact
1499 $wgEnotifFromEditor = false;
1501 // TODO move UPO to preferences probably ?
1502 # If set to true, users get a corresponding option in their preferences and can choose to
1503 # enable or disable at their discretion
1504 # If set to false, the corresponding input form on the user preference page is suppressed
1505 # It call this to be a "user-preferences-option (UPO)"
1508 * Require email authentication before sending mail to an email address.
1509 * This is highly recommended. It prevents MediaWiki from being used as an open
1512 $wgEmailAuthentication = true;
1515 * Allow users to enable email notification ("enotif") on watchlist changes.
1517 $wgEnotifWatchlist = false;
1520 * Allow users to enable email notification ("enotif") when someone edits their
1523 $wgEnotifUserTalk = false;
1526 * Set the Reply-to address in notifications to the editor's address, if user
1527 * allowed this in the preferences.
1529 $wgEnotifRevealEditorAddress = false;
1532 * Send notification mails on minor edits to watchlist pages. This is enabled
1533 * by default. Does not affect user talk notifications.
1535 $wgEnotifMinorEdits = true;
1538 * Send a generic mail instead of a personalised mail for each user. This
1539 * always uses UTC as the time zone, and doesn't include the username.
1541 * For pages with many users watching, this can significantly reduce mail load.
1542 * Has no effect when using sendmail rather than SMTP.
1544 $wgEnotifImpersonal = false;
1547 * Maximum number of users to mail at once when using impersonal mail. Should
1548 * match the limit on your mail server.
1550 $wgEnotifMaxRecips = 500;
1553 * Send mails via the job queue. This can be useful to reduce the time it
1554 * takes to save a page that a lot of people are watching.
1556 $wgEnotifUseJobQ = false;
1559 * Use real name instead of username in e-mail "from" field.
1561 $wgEnotifUseRealName = false;
1564 * Array of usernames who will be sent a notification email for every change
1565 * which occurs on a wiki. Users will not be notified of their own changes.
1567 $wgUsersNotifiedOnAllChanges = array();
1569 /** @} */ # end of email settings
1571 /************************************************************************//**
1572 * @name Database settings
1577 * Database host name or IP address
1579 $wgDBserver = 'localhost';
1582 * Database port number (for PostgreSQL and Microsoft SQL Server).
1587 * Name of the database
1589 $wgDBname = 'my_wiki';
1594 $wgDBuser = 'wikiuser';
1597 * Database user's password
1604 $wgDBtype = 'mysql';
1607 * Whether to use SSL in DB connection.
1609 * This setting is only used $wgLBFactoryConf['class'] is set to
1610 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1611 * the DBO_SSL flag must be set in the 'flags' option of the database
1612 * connection to achieve the same functionality.
1617 * Whether to use compression in DB connection.
1619 * This setting is only used $wgLBFactoryConf['class'] is set to
1620 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
1621 * the DBO_COMPRESS flag must be set in the 'flags' option of the database
1622 * connection to achieve the same functionality.
1624 $wgDBcompress = false;
1627 * Separate username for maintenance tasks. Leave as null to use the default.
1629 $wgDBadminuser = null;
1632 * Separate password for maintenance tasks. Leave as null to use the default.
1634 $wgDBadminpassword = null;
1638 * Leave as null to select the default search engine for the
1639 * selected database type (eg SearchMySQL), or set to a class
1640 * name to override to a custom search engine.
1642 $wgSearchType = null;
1645 * Alternative search types
1646 * Sometimes you want to support multiple search engines for testing. This
1647 * allows users to select their search engine of choice via url parameters
1648 * to Special:Search and the action=search API. If using this, there's no
1649 * need to add $wgSearchType to it, that is handled automatically.
1651 $wgSearchTypeAlternatives = null;
1659 * MySQL table options to use during installation or update
1661 $wgDBTableOptions = 'ENGINE=InnoDB';
1664 * SQL Mode - default is turning off all modes, including strict, if set.
1665 * null can be used to skip the setting for performance reasons and assume
1666 * DBA has done his best job.
1667 * String override can be used for some additional fun :-)
1674 $wgDBmwschema = null;
1677 * To override default SQLite data directory ($docroot/../data)
1679 $wgSQLiteDataDir = '';
1682 * Make all database connections secretly go to localhost. Fool the load balancer
1683 * thinking there is an arbitrarily large cluster of servers to connect to.
1684 * Useful for debugging.
1686 $wgAllDBsAreLocalhost = false;
1689 * Shared database for multiple wikis. Commonly used for storing a user table
1690 * for single sign-on. The server for this database must be the same as for the
1693 * For backwards compatibility the shared prefix is set to the same as the local
1694 * prefix, and the user table is listed in the default list of shared tables.
1695 * The user_properties table is also added so that users will continue to have their
1696 * preferences shared (preferences were stored in the user table prior to 1.16)
1698 * $wgSharedTables may be customized with a list of tables to share in the shared
1699 * database. However it is advised to limit what tables you do share as many of
1700 * MediaWiki's tables may have side effects if you try to share them.
1702 * $wgSharedPrefix is the table prefix for the shared database. It defaults to
1705 * @deprecated since 1.21 In new code, use the $wiki parameter to wfGetLB() to
1706 * access remote databases. Using wfGetLB() allows the shared database to
1707 * reside on separate servers to the wiki's own database, with suitable
1708 * configuration of $wgLBFactoryConf.
1715 $wgSharedPrefix = false;
1720 $wgSharedTables = array( 'user', 'user_properties' );
1723 * Database load balancer
1724 * This is a two-dimensional array, an array of server info structures
1727 * - dbname: Default database name
1729 * - password: DB password
1732 * - load: Ratio of DB_SLAVE load, must be >=0, the sum of all loads must be >0.
1733 * If this is zero for any given server, no normal query traffic will be
1734 * sent to it. It will be excluded from lag checks in maintenance scripts.
1735 * The only way it can receive traffic is if groupLoads is used.
1737 * - groupLoads: array of load ratios, the key is the query group name. A query may belong
1738 * to several groups, the most specific group defined here is used.
1740 * - flags: bit field
1741 * - DBO_DEFAULT -- turns on DBO_TRX only if !$wgCommandLineMode (recommended)
1742 * - DBO_DEBUG -- equivalent of $wgDebugDumpSql
1743 * - DBO_TRX -- wrap entire request in a transaction
1744 * - DBO_NOBUFFER -- turn off buffering (not useful in LocalSettings.php)
1745 * - DBO_PERSISTENT -- enables persistent database connections
1746 * - DBO_SSL -- uses SSL/TLS encryption in database connections, if available
1747 * - DBO_COMPRESS -- uses internal compression in database connections,
1750 * - max lag: (optional) Maximum replication lag before a slave will taken out of rotation
1752 * These and any other user-defined properties will be assigned to the mLBInfo member
1753 * variable of the Database object.
1755 * Leave at false to use the single-server variables above. If you set this
1756 * variable, the single-server variables will generally be ignored (except
1757 * perhaps in some command-line scripts).
1759 * The first server listed in this array (with key 0) will be the master. The
1760 * rest of the servers will be slaves. To prevent writes to your slaves due to
1761 * accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your
1762 * slaves in my.cnf. You can set read_only mode at runtime using:
1765 * SET @@read_only=1;
1768 * Since the effect of writing to a slave is so damaging and difficult to clean
1769 * up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even
1770 * our masters, and then set read_only=0 on masters at runtime.
1772 $wgDBservers = false;
1775 * Load balancer factory configuration
1776 * To set up a multi-master wiki farm, set the class here to something that
1777 * can return a LoadBalancer with an appropriate master on a call to getMainLB().
1778 * The class identified here is responsible for reading $wgDBservers,
1779 * $wgDBserver, etc., so overriding it may cause those globals to be ignored.
1781 * The LBFactoryMulti class is provided for this purpose, please see
1782 * includes/db/LBFactoryMulti.php for configuration information.
1784 $wgLBFactoryConf = array( 'class' => 'LBFactorySimple' );
1787 * How long to wait for a slave to catch up to the master
1788 * @deprecated since 1.24
1790 $wgMasterWaitTimeout = 10;
1793 * File to log database errors to
1795 $wgDBerrorLog = false;
1798 * Timezone to use in the error log.
1799 * Defaults to the wiki timezone ($wgLocaltimezone).
1801 * A list of usable timezones can found at:
1802 * http://php.net/manual/en/timezones.php
1806 * $wgLocaltimezone = 'UTC';
1807 * $wgLocaltimezone = 'GMT';
1808 * $wgLocaltimezone = 'PST8PDT';
1809 * $wgLocaltimezone = 'Europe/Sweden';
1810 * $wgLocaltimezone = 'CET';
1815 $wgDBerrorLogTZ = false;
1818 * Scale load balancer polling time so that under overload conditions, the
1819 * database server receives a SHOW STATUS query at an average interval of this
1822 $wgDBAvgStatusPoll = 2000;
1825 * Set to true to engage MySQL 4.1/5.0 charset-related features;
1826 * for now will just cause sending of 'SET NAMES=utf8' on connect.
1828 * @warning THIS IS EXPERIMENTAL!
1830 * May break if you're not using the table defs from mysql5/tables.sql.
1831 * May break if you're upgrading an existing wiki if set differently.
1832 * Broken symptoms likely to include incorrect behavior with page titles,
1833 * usernames, comments etc containing non-ASCII characters.
1834 * Might also cause failures on the object cache and other things.
1836 * Even correct usage may cause failures with Unicode supplementary
1837 * characters (those not in the Basic Multilingual Plane) unless MySQL
1838 * has enhanced their Unicode support.
1840 $wgDBmysql5 = false;
1843 * Set true to enable Oracle DCRP (supported from 11gR1 onward)
1845 * To use this feature set to true and use a datasource defined as
1846 * POOLED (i.e. in tnsnames definition set server=pooled in connect_data
1849 * Starting from 11gR1 you can use DCRP (Database Resident Connection
1850 * Pool) that maintains established sessions and reuses them on new
1853 * Not completely tested, but it should fall back on normal connection
1854 * in case the pool is full or the datasource is not configured as
1856 * And the other way around; using oci_pconnect on a non pooled
1857 * datasource should produce a normal connection.
1859 * When it comes to frequent shortlived DB connections like with MW
1860 * Oracle tends to s***. The problem is the driver connects to the
1861 * database reasonably fast, but establishing a session takes time and
1862 * resources. MW does not rely on session state (as it does not use
1863 * features such as package variables) so establishing a valid session
1864 * is in this case an unwanted overhead that just slows things down.
1866 * @warning EXPERIMENTAL!
1869 $wgDBOracleDRCP = false;
1872 * Other wikis on this site, can be administered from a single developer
1874 * Array numeric key => database name
1876 $wgLocalDatabases = array();
1879 * If lag is higher than $wgSlaveLagWarning, show a warning in some special
1880 * pages (like watchlist). If the lag is higher than $wgSlaveLagCritical,
1881 * show a more obvious warning.
1883 $wgSlaveLagWarning = 10;
1886 * @see $wgSlaveLagWarning
1888 $wgSlaveLagCritical = 30;
1891 * Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server
1893 $wgDBWindowsAuthentication = false;
1895 /**@}*/ # End of DB settings }
1897 /************************************************************************//**
1898 * @name Text storage
1903 * We can also compress text stored in the 'text' table. If this is set on, new
1904 * revisions will be compressed on page save if zlib support is available. Any
1905 * compressed revisions will be decompressed on load regardless of this setting,
1906 * but will not be readable at all* if zlib support is not available.
1908 $wgCompressRevisions = false;
1911 * External stores allow including content
1912 * from non database sources following URL links.
1914 * Short names of ExternalStore classes may be specified in an array here:
1916 * $wgExternalStores = array("http","file","custom")...
1919 * CAUTION: Access to database might lead to code execution
1921 $wgExternalStores = array();
1924 * An array of external MySQL servers.
1927 * Create a cluster named 'cluster1' containing three servers:
1929 * $wgExternalServers = array(
1930 * 'cluster1' => array( 'srv28', 'srv29', 'srv30' )
1934 * Used by LBFactorySimple, may be ignored if $wgLBFactoryConf is set to
1937 $wgExternalServers = array();
1940 * The place to put new revisions, false to put them in the local text table.
1941 * Part of a URL, e.g. DB://cluster1
1943 * Can be an array instead of a single string, to enable data distribution. Keys
1944 * must be consecutive integers, starting at zero.
1948 * $wgDefaultExternalStore = array( 'DB://cluster1', 'DB://cluster2' );
1953 $wgDefaultExternalStore = false;
1956 * Revision text may be cached in $wgMemc to reduce load on external storage
1957 * servers and object extraction overhead for frequently-loaded revisions.
1959 * Set to 0 to disable, or number of seconds before cache expiry.
1961 $wgRevisionCacheExpiry = 0;
1963 /** @} */ # end text storage }
1965 /************************************************************************//**
1966 * @name Performance hacks and limits
1971 * Disable database-intensive features
1973 $wgMiserMode = false;
1976 * Disable all query pages if miser mode is on, not just some
1978 $wgDisableQueryPages = false;
1981 * Number of rows to cache in 'querycache' table when miser mode is on
1983 $wgQueryCacheLimit = 1000;
1986 * Number of links to a page required before it is deemed "wanted"
1988 $wgWantedPagesThreshold = 1;
1991 * Enable slow parser functions
1993 $wgAllowSlowParserFunctions = false;
1996 * Allow schema updates
1998 $wgAllowSchemaUpdates = true;
2001 * Anti-lock flags - bitfield
2002 * - ALF_NO_LINK_LOCK:
2003 * Don't use locking reads when updating the link table. This is
2004 * necessary for wikis with a high edit rate for performance
2005 * reasons, but may cause link table inconsistency
2007 $wgAntiLockFlags = 0;
2010 * Maximum article size in kilobytes
2012 $wgMaxArticleSize = 2048;
2015 * The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to
2016 * raise PHP's memory limit if it's below this amount.
2018 $wgMemoryLimit = "50M";
2020 /** @} */ # end performance hacks }
2022 /************************************************************************//**
2023 * @name Cache settings
2028 * Directory for caching data in the local filesystem. Should not be accessible
2029 * from the web. Set this to false to not use any local caches.
2031 * Note: if multiple wikis share the same localisation cache directory, they
2032 * must all have the same set of extensions. You can set a directory just for
2033 * the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
2035 $wgCacheDirectory = false;
2038 * Main cache type. This should be a cache with fast access, but it may have
2039 * limited space. By default, it is disabled, since the database is not fast
2040 * enough to make it worthwhile.
2044 * - CACHE_ANYTHING: Use anything, as long as it works
2045 * - CACHE_NONE: Do not cache
2046 * - CACHE_DB: Store cache objects in the DB
2047 * - CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
2048 * - CACHE_ACCEL: APC, XCache or WinCache
2049 * - (other): A string may be used which identifies a cache
2050 * configuration in $wgObjectCaches.
2052 * @see $wgMessageCacheType, $wgParserCacheType
2054 $wgMainCacheType = CACHE_NONE
;
2057 * The cache type for storing the contents of the MediaWiki namespace. This
2058 * cache is used for a small amount of data which is expensive to regenerate.
2060 * For available types see $wgMainCacheType.
2062 $wgMessageCacheType = CACHE_ANYTHING
;
2065 * The cache type for storing article HTML. This is used to store data which
2066 * is expensive to regenerate, and benefits from having plenty of storage space.
2068 * For available types see $wgMainCacheType.
2070 $wgParserCacheType = CACHE_ANYTHING
;
2073 * The cache type for storing session data. Used if $wgSessionsInObjectCache is true.
2075 * For available types see $wgMainCacheType.
2077 $wgSessionCacheType = CACHE_ANYTHING
;
2080 * The cache type for storing language conversion tables,
2081 * which are used when parsing certain text and interface messages.
2083 * For available types see $wgMainCacheType.
2087 $wgLanguageConverterCacheType = CACHE_ANYTHING
;
2090 * Advanced object cache configuration.
2092 * Use this to define the class names and constructor parameters which are used
2093 * for the various cache types. Custom cache types may be defined here and
2094 * referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType,
2095 * or $wgLanguageConverterCacheType.
2097 * The format is an associative array where the key is a cache identifier, and
2098 * the value is an associative array of parameters. The "class" parameter is the
2099 * class name which will be used. Alternatively, a "factory" parameter may be
2100 * given, giving a callable function which will generate a suitable cache object.
2102 $wgObjectCaches = array(
2103 CACHE_NONE
=> array( 'class' => 'EmptyBagOStuff' ),
2104 CACHE_DB
=> array( 'class' => 'SqlBagOStuff', 'table' => 'objectcache' ),
2106 CACHE_ANYTHING
=> array( 'factory' => 'ObjectCache::newAnything' ),
2107 CACHE_ACCEL
=> array( 'factory' => 'ObjectCache::newAccelerator' ),
2108 CACHE_MEMCACHED
=> array( 'factory' => 'ObjectCache::newMemcached' ),
2110 'apc' => array( 'class' => 'APCBagOStuff' ),
2111 'xcache' => array( 'class' => 'XCacheBagOStuff' ),
2112 'wincache' => array( 'class' => 'WinCacheBagOStuff' ),
2113 'memcached-php' => array( 'class' => 'MemcachedPhpBagOStuff' ),
2114 'memcached-pecl' => array( 'class' => 'MemcachedPeclBagOStuff' ),
2115 'hash' => array( 'class' => 'HashBagOStuff' ),
2119 * The expiry time for the parser cache, in seconds.
2120 * The default is 86400 (one day).
2122 $wgParserCacheExpireTime = 86400;
2125 * Deprecated alias for $wgSessionsInObjectCache.
2127 * @deprecated since 1.20; Use $wgSessionsInObjectCache
2129 $wgSessionsInMemcached = false;
2132 * Store sessions in an object cache, configured by $wgSessionCacheType. This
2133 * can be useful to improve performance, or to avoid the locking behavior of
2134 * PHP's default session handler, which tends to prevent multiple requests for
2135 * the same user from acting concurrently.
2137 $wgSessionsInObjectCache = false;
2140 * The expiry time to use for session storage when $wgSessionsInObjectCache is
2141 * enabled, in seconds.
2143 $wgObjectCacheSessionExpiry = 3600;
2146 * This is used for setting php's session.save_handler. In practice, you will
2147 * almost never need to change this ever. Other options might be 'user' or
2148 * 'session_mysql.' Setting to null skips setting this entirely (which might be
2149 * useful if you're doing cross-application sessions, see bug 11381)
2151 $wgSessionHandler = null;
2154 * If enabled, will send MemCached debugging information to $wgDebugLogFile
2156 $wgMemCachedDebug = false;
2159 * The list of MemCached servers and port numbers
2161 $wgMemCachedServers = array( '127.0.0.1:11211' );
2164 * Use persistent connections to MemCached, which are shared across multiple
2167 $wgMemCachedPersistent = false;
2170 * Read/write timeout for MemCached server communication, in microseconds.
2172 $wgMemCachedTimeout = 500000;
2175 * Set this to true to make a local copy of the message cache, for use in
2176 * addition to memcached. The files will be put in $wgCacheDirectory.
2178 $wgUseLocalMessageCache = false;
2181 * Instead of caching everything, only cache those messages which have
2182 * been customised in the site content language. This means that
2183 * MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
2184 * This option is probably only useful for translatewiki.net.
2186 $wgAdaptiveMessageCache = false;
2189 * Localisation cache configuration. Associative array with keys:
2190 * class: The class to use. May be overridden by extensions.
2192 * store: The location to store cache data. May be 'files', 'db' or
2193 * 'detect'. If set to "files", data will be in CDB files. If set
2194 * to "db", data will be stored to the database. If set to
2195 * "detect", files will be used if $wgCacheDirectory is set,
2196 * otherwise the database will be used.
2198 * storeClass: The class name for the underlying storage. If set to a class
2199 * name, it overrides the "store" setting.
2201 * storeDirectory: If the store class puts its data in files, this is the
2202 * directory it will use. If this is false, $wgCacheDirectory
2205 * manualRecache: Set this to true to disable cache updates on web requests.
2206 * Use maintenance/rebuildLocalisationCache.php instead.
2208 $wgLocalisationCacheConf = array(
2209 'class' => 'LocalisationCache',
2210 'store' => 'detect',
2211 'storeClass' => false,
2212 'storeDirectory' => false,
2213 'manualRecache' => false,
2217 * Allow client-side caching of pages
2219 $wgCachePages = true;
2222 * Set this to current time to invalidate all prior cached pages. Affects both
2223 * client-side and server-side caching.
2224 * You can get the current date on your server by using the command:
2226 * date +%Y%m%d%H%M%S
2229 $wgCacheEpoch = '20030516000000';
2232 * Directory where GitInfo will look for pre-computed cache files. If false,
2233 * $wgCacheDirectory/gitinfo will be used.
2235 $wgGitInfoCacheDirectory = false;
2238 * Bump this number when changing the global style sheets and JavaScript.
2240 * It should be appended in the query string of static CSS and JS includes,
2241 * to ensure that client-side caches do not keep obsolete copies of global
2244 $wgStyleVersion = '303';
2247 * This will cache static pages for non-logged-in users to reduce
2248 * database traffic on public sites.
2249 * Automatically sets $wgShowIPinHeader = false
2250 * ResourceLoader requests to default language and skins are cached
2251 * as well as single module requests.
2253 $wgUseFileCache = false;
2256 * Depth of the subdirectory hierarchy to be created under
2257 * $wgFileCacheDirectory. The subdirectories will be named based on
2258 * the MD5 hash of the title. A value of 0 means all cache files will
2259 * be put directly into the main file cache directory.
2261 $wgFileCacheDepth = 2;
2264 * Keep parsed pages in a cache (objectcache table or memcached)
2265 * to speed up output of the same page viewed by another user with the
2268 * This can provide a significant speedup for medium to large pages,
2269 * so you probably want to keep it on. Extensions that conflict with the
2270 * parser cache should disable the cache on a per-page basis instead.
2272 $wgEnableParserCache = true;
2275 * Append a configured value to the parser cache and the sitenotice key so
2276 * that they can be kept separate for some class of activity.
2278 $wgRenderHashAppend = '';
2281 * If on, the sidebar navigation links are cached for users with the
2282 * current language set. This can save a touch of load on a busy site
2283 * by shaving off extra message lookups.
2285 * However it is also fragile: changing the site configuration, or
2286 * having a variable $wgArticlePath, can produce broken links that
2287 * don't update as expected.
2289 $wgEnableSidebarCache = false;
2292 * Expiry time for the sidebar cache, in seconds
2294 $wgSidebarCacheExpiry = 86400;
2297 * When using the file cache, we can store the cached HTML gzipped to save disk
2298 * space. Pages will then also be served compressed to clients that support it.
2300 * Requires zlib support enabled in PHP.
2305 * Whether MediaWiki should send an ETag header. Seems to cause
2306 * broken behavior with Squid 2.6, see bug 7098.
2311 * Clock skew or the one-second resolution of time() can occasionally cause cache
2312 * problems when the user requests two pages within a short period of time. This
2313 * variable adds a given number of seconds to vulnerable timestamps, thereby giving
2316 $wgClockSkewFudge = 5;
2319 * Invalidate various caches when LocalSettings.php changes. This is equivalent
2320 * to setting $wgCacheEpoch to the modification time of LocalSettings.php, as
2321 * was previously done in the default LocalSettings.php file.
2323 * On high-traffic wikis, this should be set to false, to avoid the need to
2324 * check the file modification time, and to avoid the performance impact of
2325 * unnecessary cache invalidations.
2327 $wgInvalidateCacheOnLocalSettingsChange = true;
2329 /** @} */ # end of cache settings
2331 /************************************************************************//**
2332 * @name HTTP proxy (Squid) settings
2334 * Many of these settings apply to any HTTP proxy used in front of MediaWiki,
2335 * although they are referred to as Squid settings for historical reasons.
2337 * Achieving a high hit ratio with an HTTP proxy requires special
2338 * configuration. See https://www.mediawiki.org/wiki/Manual:Squid_caching for
2345 * Enable/disable Squid.
2346 * See https://www.mediawiki.org/wiki/Manual:Squid_caching
2348 $wgUseSquid = false;
2351 * If you run Squid3 with ESI support, enable this (default:false):
2356 * Send X-Vary-Options header for better caching (requires patched Squid)
2361 * Add X-Forwarded-Proto to the Vary and X-Vary-Options headers for API
2362 * requests and RSS/Atom feeds. Use this if you have an SSL termination setup
2363 * and need to split the cache between HTTP and HTTPS for API requests,
2364 * feed requests and HTTP redirect responses in order to prevent cache
2365 * pollution. This does not affect 'normal' requests to index.php other than
2368 $wgVaryOnXFP = false;
2371 * Internal server name as known to Squid, if different.
2375 * $wgInternalServer = 'http://yourinternal.tld:8000';
2378 $wgInternalServer = false;
2381 * Cache timeout for the squid, will be sent as s-maxage (without ESI) or
2382 * Surrogate-Control (with ESI). Without ESI, you should strip out s-maxage in
2383 * the Squid config. 18000 seconds = 5 hours, more cache hits with 2678400 = 31
2386 $wgSquidMaxage = 18000;
2389 * Default maximum age for raw CSS/JS accesses
2391 $wgForcedRawSMaxage = 300;
2394 * List of proxy servers to purge on changes; default port is 80. Use IP addresses.
2396 * When MediaWiki is running behind a proxy, it will trust X-Forwarded-For
2397 * headers sent/modified from these proxies when obtaining the remote IP address
2399 * For a list of trusted servers which *aren't* purged, see $wgSquidServersNoPurge.
2401 $wgSquidServers = array();
2404 * As above, except these servers aren't purged on page changes; use to set a
2405 * list of trusted proxies, etc. Supports both individual IP addresses and
2407 * @since 1.23 Supports CIDR ranges
2409 $wgSquidServersNoPurge = array();
2412 * Maximum number of titles to purge in any one client operation
2414 $wgMaxSquidPurgeTitles = 400;
2417 * Whether to use a Host header in purge requests sent to the proxy servers
2418 * configured in $wgSquidServers. Set this to false to support Squid
2419 * configured in forward-proxy mode.
2421 * If this is set to true, a Host header will be sent, and only the path
2422 * component of the URL will appear on the request line, as if the request
2423 * were a non-proxy HTTP 1.1 request. Varnish only supports this style of
2424 * request. Squid supports this style of request only if reverse-proxy mode
2425 * (http_port ... accel) is enabled.
2427 * If this is set to false, no Host header will be sent, and the absolute URL
2428 * will be sent in the request line, as is the standard for an HTTP proxy
2429 * request in both HTTP 1.0 and 1.1. This style of request is not supported
2430 * by Varnish, but is supported by Squid in either configuration (forward or
2435 $wgSquidPurgeUseHostHeader = true;
2438 * Routing configuration for HTCP multicast purging. Add elements here to
2439 * enable HTCP and determine which purges are sent where. If set to an empty
2440 * array, HTCP is disabled.
2442 * Each key in this array is a regular expression to match against the purged
2443 * URL, or an empty string to match all URLs. The purged URL is matched against
2444 * the regexes in the order specified, and the first rule whose regex matches
2445 * is used, all remaining rules will thus be ignored.
2447 * @par Example configuration to send purges for upload.wikimedia.org to one
2448 * multicast group and all other purges to another:
2450 * $wgHTCPRouting = array(
2451 * '|^https?://upload\.wikimedia\.org|' => array(
2452 * 'host' => '239.128.0.113',
2456 * 'host' => '239.128.0.112',
2462 * You can also pass an array of hosts to send purges too. This is useful when
2463 * you have several multicast groups or unicast address that should receive a
2464 * given purge. Multiple hosts support was introduced in MediaWiki 1.22.
2466 * @par Example of sending purges to multiple hosts:
2468 * $wgHTCPRouting = array(
2470 * // Purges to text caches using multicast
2471 * array( 'host' => '239.128.0.114', 'port' => '4827' ),
2472 * // Purges to a hardcoded list of caches
2473 * array( 'host' => '10.88.66.1', 'port' => '4827' ),
2474 * array( 'host' => '10.88.66.2', 'port' => '4827' ),
2475 * array( 'host' => '10.88.66.3', 'port' => '4827' ),
2482 * $wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20.
2483 * For back compatibility purposes, whenever its array is empty
2484 * $wgHTCPMutlicastRouting will be used as a fallback if it not null.
2486 * @see $wgHTCPMulticastTTL
2488 $wgHTCPRouting = array();
2491 * HTCP multicast TTL.
2492 * @see $wgHTCPRouting
2494 $wgHTCPMulticastTTL = 1;
2497 * Should forwarded Private IPs be accepted?
2499 $wgUsePrivateIPs = false;
2501 /** @} */ # end of HTTP proxy settings
2503 /************************************************************************//**
2504 * @name Language, regional and character encoding settings
2509 * Site language code. See languages/Names.php for languages supported by
2510 * MediaWiki out of the box. Not all languages listed there have translations,
2511 * see languages/messages/ for the list of languages with some localisation.
2513 * Warning: Don't use language codes listed in $wgDummyLanguageCodes like "no"
2514 * for Norwegian (use "nb" instead), or things will break unexpectedly.
2516 * This defines the default interface language for all users, but users can
2517 * change it in their preferences.
2519 * This also defines the language of pages in the wiki. The content is wrapped
2520 * in a html element with lang=XX attribute. This behavior can be overridden
2521 * via hooks, see Title::getPageLanguage.
2523 $wgLanguageCode = 'en';
2526 * Language cache size, or really how many languages can we handle
2527 * simultaneously without degrading to crawl speed.
2529 $wgLangObjCacheSize = 10;
2532 * Some languages need different word forms, usually for different cases.
2533 * Used in Language::convertGrammar().
2537 * $wgGrammarForms['en']['genitive']['car'] = 'car\'s';
2540 $wgGrammarForms = array();
2543 * Treat language links as magic connectors, not inline links
2545 $wgInterwikiMagic = true;
2548 * Hide interlanguage links from the sidebar
2550 $wgHideInterlanguageLinks = false;
2553 * List of additional interwiki prefixes that should be treated as
2554 * interlanguage links (i.e. placed in the sidebar).
2556 * - This will not do anything unless the prefixes are defined in the interwiki
2558 * - The display text for these custom interlanguage links will be fetched from
2559 * the system message "interlanguage-link-xyz" where xyz is the prefix in
2561 * - A friendly name for each site, used for tooltip text, may optionally be
2562 * placed in the system message "interlanguage-link-sitename-xyz" where xyz is
2563 * the prefix in this array.
2565 $wgExtraInterlanguageLinkPrefixes = array();
2568 * List of language names or overrides for default names in Names.php
2570 $wgExtraLanguageNames = array();
2573 * List of language codes that don't correspond to an actual language.
2574 * These codes are mostly left-offs from renames, or other legacy things.
2575 * This array makes them not appear as a selectable language on the installer,
2576 * and excludes them when running the transstat.php script.
2578 $wgDummyLanguageCodes = array(
2581 'be-x-old' => 'be-tarask',
2585 'qqq' => 'qqq', # Used for message documentation.
2586 'qqx' => 'qqx', # Used for viewing message keys.
2589 'zh-classical' => 'lzh',
2590 'zh-min-nan' => 'nan',
2595 * Character set for use in the article edit box. Language-specific encodings
2598 * This historic feature is one of the first that was added by former MediaWiki
2599 * team leader Brion Vibber, and is used to support the Esperanto x-system.
2601 $wgEditEncoding = '';
2604 * Set this to true to replace Arabic presentation forms with their standard
2605 * forms in the U+0600-U+06FF block. This only works if $wgLanguageCode is
2608 * Note that pages with titles containing presentation forms will become
2609 * inaccessible, run maintenance/cleanupTitles.php to fix this.
2611 $wgFixArabicUnicode = true;
2614 * Set this to true to replace ZWJ-based chillu sequences in Malayalam text
2615 * with their Unicode 5.1 equivalents. This only works if $wgLanguageCode is
2616 * set to "ml". Note that some clients (even new clients as of 2010) do not
2617 * support these characters.
2619 * If you enable this on an existing wiki, run maintenance/cleanupTitles.php to
2620 * fix any ZWJ sequences in existing page titles.
2622 $wgFixMalayalamUnicode = true;
2625 * Set this to always convert certain Unicode sequences to modern ones
2626 * regardless of the content language. This has a small performance
2629 * See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion
2634 $wgAllUnicodeFixes = false;
2637 * Set this to eg 'ISO-8859-1' to perform character set conversion when
2638 * loading old revisions not marked with "utf-8" flag. Use this when
2639 * converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the
2640 * burdensome mass conversion of old text data.
2642 * @note This DOES NOT touch any fields other than old_text. Titles, comments,
2643 * user names, etc still must be converted en masse in the database before
2644 * continuing as a UTF-8 wiki.
2646 $wgLegacyEncoding = false;
2649 * Browser Blacklist for unicode non compliant browsers. Contains a list of
2650 * regexps : "/regexp/" matching problematic browsers. These browsers will
2651 * be served encoded unicode in the edit box instead of real unicode.
2653 $wgBrowserBlackList = array(
2655 * Netscape 2-4 detection
2656 * The minor version may contain strings such as "Gold" or "SGoldC-SGI"
2657 * Lots of non-netscape user agents have "compatible", so it's useful to check for that
2658 * with a negative assertion. The [UIN] identifier specifies the level of security
2659 * in a Netscape/Mozilla browser, checking for it rules out a number of fakers.
2660 * The language string is unreliable, it is missing on NS4 Mac.
2662 * Reference: http://www.psychedelix.com/agents/index.shtml
2664 '/^Mozilla\/2\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2665 '/^Mozilla\/3\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2666 '/^Mozilla\/4\.[^ ]+ [^(]*?\((?!compatible).*; [UIN]/',
2669 * MSIE on Mac OS 9 is teh sux0r, converts þ to <thorn>, ð to <eth>,
2670 * Þ to <THORN> and Ð to <ETH>
2673 * - Mozilla/4.0 (compatible; MSIE 5.0; Mac_PowerPC)
2674 * - Mozilla/4.0 (compatible; MSIE 5.15; Mac_PowerPC)
2675 * - Mozilla/4.0 (compatible; MSIE 5.23; Mac_PowerPC)
2678 * @link http://en.wikipedia.org/w/index.php?diff=12356041&oldid=12355864
2679 * @link http://en.wikipedia.org/wiki/Template%3AOS9
2681 '/^Mozilla\/4\.0 \(compatible; MSIE \d+\.\d+; Mac_PowerPC\)/',
2684 * Google wireless transcoder, seems to eat a lot of chars alive
2685 * http://it.wikipedia.org/w/index.php?title=Luciano_Ligabue&diff=prev&oldid=8857361
2687 '/^Mozilla\/4\.0 \(compatible; MSIE 6.0; Windows NT 5.0; Google Wireless Transcoder;\)/'
2691 * If set to true, the MediaWiki 1.4 to 1.5 schema conversion will
2692 * create stub reference rows in the text table instead of copying
2693 * the full text of all current entries from 'cur' to 'text'.
2695 * This will speed up the conversion step for large sites, but
2696 * requires that the cur table be kept around for those revisions
2697 * to remain viewable.
2699 * This option affects the updaters *only*. Any present cur stub
2700 * revisions will be readable at runtime regardless of this setting.
2702 $wgLegacySchemaConversion = false;
2705 * Enable dates like 'May 12' instead of '12 May', this only takes effect if
2706 * the interface is set to English.
2708 $wgAmericanDates = false;
2711 * For Hindi and Arabic use local numerals instead of Western style (0-9)
2712 * numerals in interface.
2714 $wgTranslateNumerals = true;
2717 * Translation using MediaWiki: namespace.
2718 * Interface messages will be loaded from the database.
2720 $wgUseDatabaseMessages = true;
2723 * Expiry time for the message cache key
2725 $wgMsgCacheExpiry = 86400;
2728 * Maximum entry size in the message cache, in bytes
2730 $wgMaxMsgCacheEntrySize = 10000;
2733 * Whether to enable language variant conversion.
2735 $wgDisableLangConversion = false;
2738 * Whether to enable language variant conversion for links.
2740 $wgDisableTitleConversion = false;
2743 * Default variant code, if false, the default will be the language code
2745 $wgDefaultLanguageVariant = false;
2748 * Disabled variants array of language variant conversion.
2752 * $wgDisabledVariants[] = 'zh-mo';
2753 * $wgDisabledVariants[] = 'zh-my';
2756 $wgDisabledVariants = array();
2759 * Like $wgArticlePath, but on multi-variant wikis, this provides a
2760 * path format that describes which parts of the URL contain the
2765 * $wgLanguageCode = 'sr';
2766 * $wgVariantArticlePath = '/$2/$1';
2767 * $wgArticlePath = '/wiki/$1';
2770 * A link to /wiki/ would be redirected to /sr/Главна_страна
2772 * It is important that $wgArticlePath not overlap with possible values
2773 * of $wgVariantArticlePath.
2775 $wgVariantArticlePath = false;
2778 * Show a bar of language selection links in the user login and user
2779 * registration forms; edit the "loginlanguagelinks" message to
2782 $wgLoginLanguageSelector = false;
2785 * When translating messages with wfMessage(), it is not always clear what
2786 * should be considered UI messages and what should be content messages.
2788 * For example, for the English Wikipedia, there should be only one 'mainpage',
2789 * so when getting the link for 'mainpage', we should treat it as site content
2790 * and call ->inContentLanguage()->text(), but for rendering the text of the
2791 * link, we call ->text(). The code behaves this way by default. However,
2792 * sites like the Wikimedia Commons do offer different versions of 'mainpage'
2793 * and the like for different languages. This array provides a way to override
2794 * the default behavior.
2797 * To allow language-specific main page and community
2800 * $wgForceUIMsgAsContentMsg = array( 'mainpage', 'portal-url' );
2803 $wgForceUIMsgAsContentMsg = array();
2806 * Fake out the timezone that the server thinks it's in. This will be used for
2807 * date display and not for what's stored in the DB. Leave to null to retain
2808 * your server's OS-based timezone value.
2810 * This variable is currently used only for signature formatting and for local
2811 * time/date parser variables ({{LOCALTIME}} etc.)
2813 * Timezones can be translated by editing MediaWiki messages of type
2814 * timezone-nameinlowercase like timezone-utc.
2816 * A list of usable timezones can found at:
2817 * http://php.net/manual/en/timezones.php
2821 * $wgLocaltimezone = 'UTC';
2822 * $wgLocaltimezone = 'GMT';
2823 * $wgLocaltimezone = 'PST8PDT';
2824 * $wgLocaltimezone = 'Europe/Sweden';
2825 * $wgLocaltimezone = 'CET';
2828 $wgLocaltimezone = null;
2831 * Set an offset from UTC in minutes to use for the default timezone setting
2832 * for anonymous users and new user accounts.
2834 * This setting is used for most date/time displays in the software, and is
2835 * overridable in user preferences. It is *not* used for signature timestamps.
2837 * By default, this will be set to match $wgLocaltimezone.
2839 $wgLocalTZoffset = null;
2841 /** @} */ # End of language/charset settings
2843 /*************************************************************************//**
2844 * @name Output format and skin settings
2849 * The default Content-Type header.
2851 $wgMimeType = 'text/html';
2854 * Previously used as content type in HTML script tags. This is now ignored since
2855 * HTML5 doesn't require a MIME type for script tags (javascript is the default).
2856 * It was also previously used by RawAction to determine the ctype query parameter
2857 * value that will result in a javascript response.
2858 * @deprecated since 1.22
2860 $wgJsMimeType = null;
2863 * The default xmlns attribute. The option to define this has been removed.
2864 * The value of this variable is no longer used by core and is set to a fixed
2865 * value in Setup.php for compatibility with extensions that depend on the value
2866 * of this variable being set. Such a dependency however is deprecated.
2867 * @deprecated since 1.22
2869 $wgXhtmlDefaultNamespace = null;
2872 * Previously used to determine if we should output an HTML5 doctype.
2873 * This is no longer used as we always output HTML5 now. For compatibility with
2874 * extensions that still check the value of this config it's value is now forced
2875 * to true by Setup.php.
2876 * @deprecated since 1.22
2881 * Defines the value of the version attribute in the <html> tag, if any.
2882 * If $wgAllowRdfaAttributes is true, and this evaluates to boolean false
2883 * (like if it's left at the default null value), it will be auto-initialized
2884 * to the correct value for RDFa+HTML5. As such, you should have no reason to
2885 * ever actually set this to anything.
2887 $wgHtml5Version = null;
2890 * Temporary variable that allows HTMLForms to be rendered as tables.
2891 * Table based layouts cause various issues when designing for mobile.
2892 * This global allows skins or extensions a means to force non-table based rendering.
2893 * Setting to false forces form components to always render as div elements.
2896 $wgHTMLFormAllowTableFormat = true;
2899 * Temporary variable that applies MediaWiki UI wherever it can be supported.
2900 * Temporary variable that should be removed when mediawiki ui is more
2901 * stable and change has been communicated.
2904 $wgUseMediaWikiUIEverywhere = false;
2907 * Enabled RDFa attributes for use in wikitext.
2908 * NOTE: Interaction with HTML5 is somewhat underspecified.
2910 $wgAllowRdfaAttributes = false;
2913 * Enabled HTML5 microdata attributes for use in wikitext.
2915 $wgAllowMicrodataAttributes = false;
2918 * Should we try to make our HTML output well-formed XML? If set to false,
2919 * output will be a few bytes shorter, and the HTML will arguably be more
2920 * readable. If set to true, life will be much easier for the authors of
2921 * screen-scraping bots, and the HTML will arguably be more readable.
2923 * Setting this to false may omit quotation marks on some attributes, omit
2924 * slashes from some self-closing tags, omit some ending tags, etc., where
2925 * permitted by HTML5. Setting it to true will not guarantee that all pages
2926 * will be well-formed, although non-well-formed pages should be rare and it's
2927 * a bug if you find one. Conversely, setting it to false doesn't mean that
2928 * all XML-y constructs will be omitted, just that they might be.
2930 * Because of compatibility with screen-scraping bots, and because it's
2931 * controversial, this is currently left to true by default.
2933 $wgWellFormedXml = true;
2936 * Permit other namespaces in addition to the w3.org default.
2938 * Use the prefix for the key and the namespace for the value.
2942 * $wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
2944 * Normally we wouldn't have to define this in the root "<html>"
2945 * element, but IE needs it there in some circumstances.
2947 * This is ignored if $wgMimeType is set to a non-XML MIME type.
2949 $wgXhtmlNamespaces = array();
2952 * Show IP address, for non-logged in users. It's necessary to switch this off
2953 * for some forms of caching.
2954 * @warning Will disable file cache.
2956 $wgShowIPinHeader = true;
2959 * Site notice shown at the top of each page
2961 * MediaWiki:Sitenotice page, which will override this. You can also
2962 * provide a separate message for logged-out users using the
2963 * MediaWiki:Anonnotice page.
2968 * If this is set, a "donate" link will appear in the sidebar. Set it to a URL.
2970 $wgSiteSupportPage = '';
2973 * Validate the overall output using tidy and refuse
2974 * to display the page if it's not valid.
2976 $wgValidateAllHtml = false;
2979 * Default skin, for new users and anonymous visitors. Registered users may
2980 * change this to any one of the other available skins in their preferences.
2982 $wgDefaultSkin = 'vector';
2985 * Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
2989 $wgFallbackSkin = 'fallback';
2992 * Specify the names of skins that should not be presented in the list of
2993 * available skins in user preferences. If you want to remove a skin entirely,
2994 * remove it from the skins/ directory and its entry from LocalSettings.php.
2996 $wgSkipSkins = array();
2999 * @deprecated since 1.23; use $wgSkipSkins instead
3004 * Allow user Javascript page?
3005 * This enables a lot of neat customizations, but may
3006 * increase security risk to users and server load.
3008 $wgAllowUserJs = false;
3011 * Allow user Cascading Style Sheets (CSS)?
3012 * This enables a lot of neat customizations, but may
3013 * increase security risk to users and server load.
3015 $wgAllowUserCss = false;
3018 * Allow user-preferences implemented in CSS?
3019 * This allows users to customise the site appearance to a greater
3020 * degree; disabling it will improve page load times.
3022 $wgAllowUserCssPrefs = true;
3025 * Use the site's Javascript page?
3027 $wgUseSiteJs = true;
3030 * Use the site's Cascading Style Sheets (CSS)?
3032 $wgUseSiteCss = true;
3035 * Break out of framesets. This can be used to prevent clickjacking attacks,
3036 * or to prevent external sites from framing your site with ads.
3038 $wgBreakFrames = false;
3041 * The X-Frame-Options header to send on pages sensitive to clickjacking
3042 * attacks, such as edit pages. This prevents those pages from being displayed
3043 * in a frame or iframe. The options are:
3045 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3047 * - 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used
3048 * to allow framing within a trusted domain. This is insecure if there
3049 * is a page on the same domain which allows framing of arbitrary URLs.
3051 * - false: Allow all framing. This opens up the wiki to XSS attacks and thus
3052 * full compromise of local user accounts. Private wikis behind a
3053 * corporate firewall are especially vulnerable. This is not
3056 * For extra safety, set $wgBreakFrames = true, to prevent framing on all pages,
3057 * not just edit pages.
3059 $wgEditPageFrameOptions = 'DENY';
3062 * Disallow framing of API pages directly, by setting the X-Frame-Options
3063 * header. Since the API returns CSRF tokens, allowing the results to be
3064 * framed can compromise your user's account security.
3066 * - 'DENY': Do not allow framing. This is recommended for most wikis.
3067 * - 'SAMEORIGIN': Allow framing by pages on the same domain.
3068 * - false: Allow all framing.
3070 $wgApiFrameOptions = 'DENY';
3073 * Disable output compression (enabled by default if zlib is available)
3075 $wgDisableOutputCompression = false;
3078 * Should we allow a broader set of characters in id attributes, per HTML5? If
3079 * not, use only HTML 4-compatible IDs. This option is for testing -- when the
3080 * functionality is ready, it will be on by default with no option.
3082 * Currently this appears to work fine in all browsers, but it's disabled by
3083 * default because it normalizes id's a bit too aggressively, breaking preexisting
3084 * content (particularly Cite). See bug 27733, bug 27694, bug 27474.
3086 $wgExperimentalHtmlIds = false;
3089 * Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code
3090 * You can add new icons to the built in copyright or poweredby, or you can create
3091 * a new block. Though note that you may need to add some custom css to get good styling
3092 * of new blocks in monobook. vector and modern should work without any special css.
3094 * $wgFooterIcons itself is a key/value array.
3095 * The key is the name of a block that the icons will be wrapped in. The final id varies
3096 * by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern
3097 * turns it into mw_poweredby.
3098 * The value is either key/value array of icons or a string.
3099 * In the key/value array the key may or may not be used by the skin but it can
3100 * be used to find the icon and unset it or change the icon if needed.
3101 * This is useful for disabling icons that are set by extensions.
3102 * The value should be either a string or an array. If it is a string it will be output
3103 * directly as html, however some skins may choose to ignore it. An array is the preferred format
3104 * for the icon, the following keys are used:
3105 * - src: An absolute url to the image to use for the icon, this is recommended
3106 * but not required, however some skins will ignore icons without an image
3107 * - url: The url to use in the a element around the text or icon, if not set an a element will
3109 * - alt: This is the text form of the icon, it will be displayed without an image in
3110 * skins like Modern or if src is not set, and will otherwise be used as
3111 * the alt="" for the image. This key is required.
3112 * - width and height: If the icon specified by src is not of the standard size
3113 * you can specify the size of image to use with these keys.
3114 * Otherwise they will default to the standard 88x31.
3115 * @todo Reformat documentation.
3117 $wgFooterIcons = array(
3118 "copyright" => array(
3119 "copyright" => array(), // placeholder for the built in copyright icon
3121 "poweredby" => array(
3122 "mediawiki" => array(
3123 "src" => null, // Defaults to "$wgStylePath/common/images/poweredby_mediawiki_88x31.png"
3124 "url" => "//www.mediawiki.org/",
3125 "alt" => "Powered by MediaWiki",
3131 * Login / create account link behavior when it's possible for anonymous users
3132 * to create an account.
3133 * - true = use a combined login / create account link
3134 * - false = split login and create account into two separate links
3136 $wgUseCombinedLoginLink = false;
3139 * Display user edit counts in various prominent places.
3141 $wgEdititis = false;
3144 * Some web hosts attempt to rewrite all responses with a 404 (not found)
3145 * status code, mangling or hiding MediaWiki's output. If you are using such a
3146 * host, you should start looking for a better one. While you're doing that,
3147 * set this to false to convert some of MediaWiki's 404 responses to 200 so
3148 * that the generated error pages can be seen.
3150 * In cases where for technical reasons it is more important for MediaWiki to
3151 * send the correct status code than for the body to be transmitted intact,
3152 * this configuration variable is ignored.
3154 $wgSend404Code = true;
3157 * The $wgShowRollbackEditCount variable is used to show how many edits will be
3158 * rollback. The numeric value of the variable are the limit up to are counted.
3159 * If the value is false or 0, the edits are not counted. Disabling this will
3160 * furthermore prevent MediaWiki from hiding some useless rollback links.
3164 $wgShowRollbackEditCount = 10;
3167 * Output a <link rel="canonical"> tag on every page indicating the canonical
3168 * server which should be used, i.e. $wgServer or $wgCanonicalServer. Since
3169 * detection of the current server is unreliable, the link is sent
3172 $wgEnableCanonicalServerLink = false;
3174 /** @} */ # End of output format settings }
3176 /*************************************************************************//**
3177 * @name Resource loader settings
3182 * Client-side resource modules.
3184 * Extensions should add their resource loader module definitions
3185 * to the $wgResourceModules variable.
3189 * $wgResourceModules['ext.myExtension'] = array(
3190 * 'scripts' => 'myExtension.js',
3191 * 'styles' => 'myExtension.css',
3192 * 'dependencies' => array( 'jquery.cookie', 'jquery.tabIndex' ),
3193 * 'localBasePath' => __DIR__,
3194 * 'remoteExtPath' => 'MyExtension',
3198 $wgResourceModules = array();
3201 * Skin-specific styles for resource modules.
3203 * These are later added to the 'skinStyles' list of the existing module. The 'styles' list can
3204 * not be modified or disabled.
3206 * For example, here is a module "bar" and how skin Foo would provide additional styles for it.
3210 * $wgResourceModules['bar'] = array(
3211 * 'scripts' => 'resources/bar/bar.js',
3212 * 'styles' => 'resources/bar/main.css',
3215 * $wgResourceModuleSkinStyles['foo'] = array(
3216 * 'bar' => 'skins/Foo/bar.css',
3220 * This is mostly equivalent to:
3224 * $wgResourceModules['bar'] = array(
3225 * 'scripts' => 'resources/bar/bar.js',
3226 * 'styles' => 'resources/bar/main.css',
3227 * 'skinStyles' => array(
3228 * 'foo' => skins/Foo/bar.css',
3233 * If the module already defines its own entry in `skinStyles` for a given skin, then
3234 * $wgResourceModuleSkinStyles is ignored.
3236 * If a module defines a `skinStyles['default']` the skin may want to extend that instead
3237 * of replacing them. This can be done using the `+` prefix.
3241 * $wgResourceModules['bar'] = array(
3242 * 'scripts' => 'resources/bar/bar.js',
3243 * 'styles' => 'resources/bar/basic.css',
3244 * 'skinStyles' => array(
3245 * 'default' => 'resources/bar/additional.css',
3248 * // Note the '+' character:
3249 * $wgResourceModuleSkinStyles['+foo'] = array(
3250 * 'bar' => 'skins/Foo/bar.css',
3254 * This is mostly equivalent to:
3258 * $wgResourceModules['bar'] = array(
3259 * 'scripts' => 'resources/bar/bar.js',
3260 * 'styles' => 'resources/bar/basic.css',
3261 * 'skinStyles' => array(
3262 * 'default' => 'resources/bar/additional.css',
3264 * 'resources/bar/additional.css',
3265 * 'skins/Foo/bar.css',
3271 * In other words, as a module author, use the `styles` list for stylesheets that may not be
3272 * disabled by a skin. To provide default styles that may be extended or replaced,
3273 * use `skinStyles['default']`.
3275 * As with $wgResourceModules, paths default to being relative to the MediaWiki root.
3276 * You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).
3277 * Either for all skin styles at once (first example below) or for each module separately (second
3282 * $wgResourceModuleSkinStyles['foo'] = array(
3283 * 'bar' => 'bar.css',
3284 * 'quux' => 'quux.css',
3285 * 'remoteSkinPath' => 'Foo',
3286 * 'localBasePath' => __DIR__,
3289 * $wgResourceModuleSkinStyles['foo'] = array(
3292 * 'remoteSkinPath' => 'Foo',
3293 * 'localBasePath' => __DIR__,
3297 * 'remoteSkinPath' => 'Foo',
3298 * 'localBasePath' => __DIR__,
3303 $wgResourceModuleSkinStyles = array();
3306 * Extensions should register foreign module sources here. 'local' is a
3307 * built-in source that is not in this array, but defined by
3308 * ResourceLoader::__construct() so that it cannot be unset.
3312 * $wgResourceLoaderSources['foo'] = array(
3313 * 'loadScript' => 'http://example.org/w/load.php',
3314 * 'apiScript' => 'http://example.org/w/api.php'
3318 $wgResourceLoaderSources = array();
3321 * Default 'remoteBasePath' value for instances of ResourceLoaderFileModule.
3322 * If not set, then $wgScriptPath will be used as a fallback.
3324 $wgResourceBasePath = null;
3327 * Maximum time in seconds to cache resources served by the resource loader.
3328 * Used to set last modified headers (max-age/s-maxage).
3330 * Following options to distinguish:
3331 * - versioned: Used for modules with a version, because changing version
3332 * numbers causes cache misses. This normally has a long expiry time.
3333 * - unversioned: Used for modules without a version to propagate changes
3334 * quickly to clients. Also used for modules with errors to recover quickly.
3335 * This normally has a short expiry time.
3337 * Expiry time for the options to distinguish:
3338 * - server: Squid/Varnish but also any other public proxy cache between the
3339 * client and MediaWiki.
3340 * - client: On the client side (e.g. in the browser cache).
3342 $wgResourceLoaderMaxage = array(
3343 'versioned' => array(
3344 'server' => 30 * 24 * 60 * 60, // 30 days
3345 'client' => 30 * 24 * 60 * 60, // 30 days
3347 'unversioned' => array(
3348 'server' => 5 * 60, // 5 minutes
3349 'client' => 5 * 60, // 5 minutes
3354 * The default debug mode (on/off) for of ResourceLoader requests.
3356 * This will still be overridden when the debug URL parameter is used.
3358 $wgResourceLoaderDebug = false;
3361 * Enable embedding of certain resources using Edge Side Includes. This will
3362 * improve performance but only works if there is something in front of the
3363 * web server (e..g a Squid or Varnish server) configured to process the ESI.
3365 $wgResourceLoaderUseESI = false;
3368 * Put each statement on its own line when minifying JavaScript. This makes
3369 * debugging in non-debug mode a bit easier.
3371 $wgResourceLoaderMinifierStatementsOnOwnLine = false;
3374 * Maximum line length when minifying JavaScript. This is not a hard maximum:
3375 * the minifier will try not to produce lines longer than this, but may be
3376 * forced to do so in certain cases.
3378 $wgResourceLoaderMinifierMaxLineLength = 1000;
3381 * Whether to include the mediawiki.legacy JS library (old wikibits.js), and its
3384 $wgIncludeLegacyJavaScript = true;
3387 * Whether to include the jQuery Migrate library, which lets legacy JS that
3388 * requires jQuery 1.8.x to work and breaks with 1.9.x+.
3391 * @deprecated since 1.24, to be removed in 1.25
3393 $wgIncludejQueryMigrate = false;
3396 * Whether to preload the mediawiki.util module as blocking module in the top
3399 * Before MediaWiki 1.19, modules used to load slower/less asynchronous which
3400 * allowed modules to lack dependencies on 'popular' modules that were likely
3403 * This setting is to aid scripts during migration by providing mediawiki.util
3404 * unconditionally (which was the most commonly missed dependency).
3405 * It doesn't cover all missing dependencies obviously but should fix most of
3408 * This should be removed at some point after site/user scripts have been fixed.
3409 * Enable this if your wiki has a large amount of user/site scripts that are
3410 * lacking dependencies.
3413 $wgPreloadJavaScriptMwUtil = false;
3416 * Whether or not to assign configuration variables to the global window object.
3418 * If this is set to false, old code using deprecated variables will no longer
3421 * @par Example of legacy code:
3423 * if ( window.wgRestrictionEdit ) { ... }
3427 * if ( wgIsArticle ) { ... }
3430 * Instead, one needs to use mw.config.
3431 * @par Example using mw.config global configuration:
3433 * if ( mw.config.exists('wgRestrictionEdit') ) { ... }
3437 * if ( mw.config.get('wgIsArticle') ) { ... }
3440 $wgLegacyJavaScriptGlobals = true;
3443 * If set to a positive number, ResourceLoader will not generate URLs whose
3444 * query string is more than this many characters long, and will instead use
3445 * multiple requests with shorter query strings. This degrades performance,
3446 * but may be needed if your web server has a low (less than, say 1024)
3447 * query string length limit or a low value for suhosin.get.max_value_length
3448 * that you can't increase.
3450 * If set to a negative number, ResourceLoader will assume there is no query
3451 * string length limit.
3453 * Defaults to a value based on php configuration.
3455 $wgResourceLoaderMaxQueryLength = false;
3458 * If set to true, JavaScript modules loaded from wiki pages will be parsed
3459 * prior to minification to validate it.
3461 * Parse errors will result in a JS exception being thrown during module load,
3462 * which avoids breaking other modules loaded in the same request.
3464 $wgResourceLoaderValidateJS = true;
3467 * If set to true, statically-sourced (file-backed) JavaScript resources will
3468 * be parsed for validity before being bundled up into ResourceLoader modules.
3470 * This can be helpful for development by providing better error messages in
3471 * default (non-debug) mode, but JavaScript parsing is slow and memory hungry
3472 * and may fail on large pre-bundled frameworks.
3474 $wgResourceLoaderValidateStaticJS = false;
3477 * If set to true, asynchronous loading of bottom-queue scripts in the "<head>"
3478 * will be enabled. This is an experimental feature that's supposed to make
3479 * JavaScript load faster.
3481 $wgResourceLoaderExperimentalAsyncLoading = false;
3484 * Global LESS variables. An associative array binding variable names to
3485 * LESS code snippets representing their values.
3487 * Adding an item here is equivalent to writing `@variable: value;`
3488 * at the beginning of all your .less files, with all the consequences.
3489 * In particular, string values must be escaped and quoted.
3491 * Changes to LESS variables do not trigger cache invalidation.
3495 * $wgResourceLoaderLESSVars = array(
3496 * 'baseFontSize' => '1em',
3497 * 'smallFontSize' => '0.75em',
3498 * 'WikimediaBlue' => '#006699',
3503 $wgResourceLoaderLESSVars = array();
3506 * Custom LESS functions. An associative array mapping function name to PHP
3509 * Changes to LESS functions do not trigger cache invalidation.
3513 $wgResourceLoaderLESSFunctions = array(
3514 'embeddable' => 'ResourceLoaderLESSFunctions::embeddable',
3515 'embed' => 'ResourceLoaderLESSFunctions::embed',
3519 * Default import paths for LESS modules. LESS files referenced in @import
3520 * statements will be looked up here first, and relative to the importing file
3521 * second. To avoid collisions, it's important for the LESS files in these
3522 * directories to have a common, predictable file name prefix.
3524 * Extensions need not (and should not) register paths in
3525 * $wgResourceLoaderLESSImportPaths. The import path includes the path of the
3526 * currently compiling LESS file, which allows each extension to freely import
3527 * files from its own tree.
3531 $wgResourceLoaderLESSImportPaths = array(
3532 "$IP/resources/src/mediawiki.less/",
3536 * Whether ResourceLoader should attempt to persist modules in localStorage on
3537 * browsers that support the Web Storage API.
3539 * @since 1.23 - Client-side module persistence is experimental. Exercise care.
3541 $wgResourceLoaderStorageEnabled = false;
3544 * Cache version for client-side ResourceLoader module storage. You can trigger
3545 * invalidation of the contents of the module store by incrementing this value.
3549 $wgResourceLoaderStorageVersion = 1;
3551 /** @} */ # End of resource loader settings }
3553 /*************************************************************************//**
3554 * @name Page title and interwiki link settings
3559 * Name of the project namespace. If left set to false, $wgSitename will be
3562 $wgMetaNamespace = false;
3565 * Name of the project talk namespace.
3567 * Normally you can ignore this and it will be something like
3568 * $wgMetaNamespace . "_talk". In some languages, you may want to set this
3569 * manually for grammatical reasons.
3571 $wgMetaNamespaceTalk = false;
3574 * Additional namespaces. If the namespaces defined in Language.php and
3575 * Namespace.php are insufficient, you can create new ones here, for example,
3576 * to import Help files in other languages. You can also override the namespace
3577 * names of existing namespaces. Extensions developers should use
3578 * $wgCanonicalNamespaceNames.
3580 * @warning Once you delete a namespace, the pages in that namespace will
3581 * no longer be accessible. If you rename it, then you can access them through
3582 * the new namespace name.
3584 * Custom namespaces should start at 100 to avoid conflicting with standard
3585 * namespaces, and should always follow the even/odd main/talk pattern.
3589 * $wgExtraNamespaces = array(
3591 * 101 => "Hilfe_Diskussion",
3593 * 103 => "Discussion_Aide"
3597 * @todo Add a note about maintenance/namespaceDupes.php
3599 $wgExtraNamespaces = array();
3602 * Same as above, but for namespaces with gender distinction.
3603 * Note: the default form for the namespace should also be set
3604 * using $wgExtraNamespaces for the same index.
3607 $wgExtraGenderNamespaces = array();
3610 * Namespace aliases.
3612 * These are alternate names for the primary localised namespace names, which
3613 * are defined by $wgExtraNamespaces and the language file. If a page is
3614 * requested with such a prefix, the request will be redirected to the primary
3617 * Set this to a map from namespace names to IDs.
3621 * $wgNamespaceAliases = array(
3622 * 'Wikipedian' => NS_USER,
3627 $wgNamespaceAliases = array();
3630 * Allowed title characters -- regex character class
3631 * Don't change this unless you know what you're doing
3633 * Problematic punctuation:
3634 * - []{}|# Are needed for link syntax, never enable these
3635 * - <> Causes problems with HTML escaping, don't use
3636 * - % Enabled by default, minor problems with path to query rewrite rules, see below
3637 * - + Enabled by default, but doesn't work with path to query rewrite rules,
3638 * corrupted by apache
3639 * - ? Enabled by default, but doesn't work with path to PATH_INFO rewrites
3641 * All three of these punctuation problems can be avoided by using an alias,
3642 * instead of a rewrite rule of either variety.
3644 * The problem with % is that when using a path to query rewrite rule, URLs are
3645 * double-unescaped: once by Apache's path conversion code, and again by PHP. So
3646 * %253F, for example, becomes "?". Our code does not double-escape to compensate
3647 * for this, indeed double escaping would break if the double-escaped title was
3648 * passed in the query string rather than the path. This is a minor security issue
3649 * because articles can be created such that they are hard to view or edit.
3651 * In some rare cases you may wish to remove + for compatibility with old links.
3653 * Theoretically 0x80-0x9F of ISO 8859-1 should be disallowed, but
3654 * this breaks interlanguage links
3656 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
3659 * The interwiki prefix of the current wiki, or false if it doesn't have one.
3661 * @deprecated since 1.23; use $wgLocalInterwikis instead
3663 $wgLocalInterwiki = false;
3666 * Array for multiple $wgLocalInterwiki values, in case there are several
3667 * interwiki prefixes that point to the current wiki. If $wgLocalInterwiki is
3668 * set, its value is prepended to this array, for backwards compatibility.
3670 * Note, recent changes feeds use only the first entry in this array (or
3671 * $wgLocalInterwiki, if it is set). See $wgRCFeeds
3673 $wgLocalInterwikis = array();
3676 * Expiry time for cache of interwiki table
3678 $wgInterwikiExpiry = 10800;
3681 * @name Interwiki caching settings.
3686 *$wgInterwikiCache specifies path to constant database file.
3688 * This cdb database is generated by dumpInterwiki from maintenance and has
3690 * - dbname:key - a simple key (e.g. enwiki:meta)
3691 * - _sitename:key - site-scope key (e.g. wiktionary:meta)
3692 * - __global:key - global-scope key (e.g. __global:meta)
3693 * - __sites:dbname - site mapping (e.g. __sites:enwiki)
3695 * Sites mapping just specifies site name, other keys provide "local url"
3698 $wgInterwikiCache = false;
3701 * Specify number of domains to check for messages.
3702 * - 1: Just wiki(db)-level
3703 * - 2: wiki and global levels
3706 $wgInterwikiScopes = 3;
3709 * Fallback site, if unable to resolve from cache
3711 $wgInterwikiFallbackSite = 'wiki';
3713 /** @} */ # end of Interwiki caching settings.
3716 * If local interwikis are set up which allow redirects,
3717 * set this regexp to restrict URLs which will be displayed
3718 * as 'redirected from' links.
3721 * It might look something like this:
3723 * $wgRedirectSources = '!^https?://[a-z-]+\.wikipedia\.org/!';
3726 * Leave at false to avoid displaying any incoming redirect markers.
3727 * This does not affect intra-wiki redirects, which don't change
3730 $wgRedirectSources = false;
3733 * Set this to false to avoid forcing the first letter of links to capitals.
3735 * @warning may break links! This makes links COMPLETELY case-sensitive. Links
3736 * appearing with a capital at the beginning of a sentence will *not* go to the
3737 * same place as links in the middle of a sentence using a lowercase initial.
3739 $wgCapitalLinks = true;
3742 * @since 1.16 - This can now be set per-namespace. Some special namespaces (such
3743 * as Special, see MWNamespace::$alwaysCapitalizedNamespaces for the full list) must be
3744 * true by default (and setting them has no effect), due to various things that
3745 * require them to be so. Also, since Talk namespaces need to directly mirror their
3746 * associated content namespaces, the values for those are ignored in favor of the
3747 * subject namespace's setting. Setting for NS_MEDIA is taken automatically from
3752 * $wgCapitalLinkOverrides[ NS_FILE ] = false;
3755 $wgCapitalLinkOverrides = array();
3758 * Which namespaces should support subpages?
3759 * See Language.php for a list of namespaces.
3761 $wgNamespacesWithSubpages = array(
3764 NS_USER_TALK
=> true,
3766 NS_PROJECT_TALK
=> true,
3767 NS_FILE_TALK
=> true,
3768 NS_MEDIAWIKI
=> true,
3769 NS_MEDIAWIKI_TALK
=> true,
3770 NS_TEMPLATE_TALK
=> true,
3772 NS_HELP_TALK
=> true,
3773 NS_CATEGORY_TALK
=> true
3777 * Array holding default tracking category names.
3779 * Array contains the system messages for each tracking category.
3780 * Tracking categories allow pages with certain characteristics to be tracked.
3781 * It works by adding any such page to a category automatically.
3783 * A message with the suffix '-desc' should be added as a description message
3784 * to have extra information on Special:TrackingCategories.
3788 $wgTrackingCategories = array(
3791 'expensive-parserfunction-category',
3792 'post-expand-template-argument-category',
3793 'post-expand-template-inclusion-category',
3794 'hidden-category-category',
3795 'broken-file-category',
3796 'node-count-exceeded-category',
3797 'expansion-depth-exceeded-category',
3801 * Array of namespaces which can be deemed to contain valid "content", as far
3802 * as the site statistics are concerned. Useful if additional namespaces also
3803 * contain "content" which should be considered when generating a count of the
3804 * number of articles in the wiki.
3806 $wgContentNamespaces = array( NS_MAIN
);
3809 * Max number of redirects to follow when resolving redirects.
3810 * 1 means only the first redirect is followed (default behavior).
3811 * 0 or less means no redirects are followed.
3813 $wgMaxRedirects = 1;
3816 * Array of invalid page redirect targets.
3817 * Attempting to create a redirect to any of the pages in this array
3818 * will make the redirect fail.
3819 * Userlogout is hard-coded, so it does not need to be listed here.
3820 * (bug 10569) Disallow Mypage and Mytalk as well.
3822 * As of now, this only checks special pages. Redirects to pages in
3823 * other namespaces cannot be invalidated by this variable.
3825 $wgInvalidRedirectTargets = array( 'Filepath', 'Mypage', 'Mytalk', 'Redirect' );
3827 /** @} */ # End of title and interwiki settings }
3829 /************************************************************************//**
3830 * @name Parser settings
3831 * These settings configure the transformation from wikitext to HTML.
3836 * Parser configuration. Associative array with the following members:
3838 * class The class name
3840 * preprocessorClass The preprocessor class. Two classes are currently available:
3841 * Preprocessor_Hash, which uses plain PHP arrays for temporary
3842 * storage, and Preprocessor_DOM, which uses the DOM module for
3843 * temporary storage. Preprocessor_DOM generally uses less memory;
3844 * the speed of the two is roughly the same.
3846 * If this parameter is not given, it uses Preprocessor_DOM if the
3847 * DOM module is available, otherwise it uses Preprocessor_Hash.
3849 * The entire associative array will be passed through to the constructor as
3850 * the first parameter. Note that only Setup.php can use this variable --
3851 * the configuration will change at runtime via $wgParser member functions, so
3852 * the contents of this variable will be out-of-date. The variable can only be
3853 * changed during LocalSettings.php, in particular, it can't be changed during
3854 * an extension setup function.
3856 $wgParserConf = array(
3857 'class' => 'Parser',
3858 #'preprocessorClass' => 'Preprocessor_Hash',
3862 * Maximum indent level of toc.
3864 $wgMaxTocLevel = 999;
3867 * A complexity limit on template expansion: the maximum number of nodes visited
3868 * by PPFrame::expand()
3870 $wgMaxPPNodeCount = 1000000;
3873 * A complexity limit on template expansion: the maximum number of elements
3874 * generated by Preprocessor::preprocessToObj(). This allows you to limit the
3875 * amount of memory used by the Preprocessor_DOM node cache: testing indicates
3876 * that each element uses about 160 bytes of memory on a 64-bit processor, so
3877 * this default corresponds to about 155 MB.
3879 * When the limit is exceeded, an exception is thrown.
3881 $wgMaxGeneratedPPNodeCount = 1000000;
3884 * Maximum recursion depth for templates within templates.
3885 * The current parser adds two levels to the PHP call stack for each template,
3886 * and xdebug limits the call stack to 100 by default. So this should hopefully
3887 * stop the parser before it hits the xdebug limit.
3889 $wgMaxTemplateDepth = 40;
3892 * @see $wgMaxTemplateDepth
3894 $wgMaxPPExpandDepth = 40;
3897 * URL schemes that should be recognized as valid by wfParseUrl().
3900 $wgUrlProtocols = array(
3901 'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
3902 'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'mms://', 'news:',
3903 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:', 'ssh://',
3904 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:', '//'
3908 * If true, removes (substitutes) templates in "~~~~" signatures.
3910 $wgCleanSignatures = true;
3913 * Whether to allow inline image pointing to other websites
3915 $wgAllowExternalImages = false;
3918 * If the above is false, you can specify an exception here. Image URLs
3919 * that start with this string are then rendered, while all others are not.
3920 * You can use this to set up a trusted, simple repository of images.
3921 * You may also specify an array of strings to allow multiple sites
3925 * $wgAllowExternalImagesFrom = 'http://127.0.0.1/';
3926 * $wgAllowExternalImagesFrom = array( 'http://127.0.0.1/', 'http://example.com' );
3929 $wgAllowExternalImagesFrom = '';
3932 * If $wgAllowExternalImages is false, you can allow an on-wiki
3933 * whitelist of regular expression fragments to match the image URL
3934 * against. If the image matches one of the regular expression fragments,
3935 * The image will be displayed.
3937 * Set this to true to enable the on-wiki whitelist (MediaWiki:External image whitelist)
3938 * Or false to disable it
3940 $wgEnableImageWhitelist = true;
3943 * A different approach to the above: simply allow the "<img>" tag to be used.
3944 * This allows you to specify alt text and other attributes, copy-paste HTML to
3945 * your wiki more easily, etc. However, allowing external images in any manner
3946 * will allow anyone with editing rights to snoop on your visitors' IP
3947 * addresses and so forth, if they wanted to, by inserting links to images on
3948 * sites they control.
3950 $wgAllowImageTag = false;
3953 * $wgUseTidy: use tidy to make sure HTML output is sane.
3954 * Tidy is a free tool that fixes broken HTML.
3955 * See http://www.w3.org/People/Raggett/tidy/
3957 * - $wgTidyBin should be set to the path of the binary and
3958 * - $wgTidyConf to the path of the configuration file.
3959 * - $wgTidyOpts can include any number of parameters.
3960 * - $wgTidyInternal controls the use of the PECL extension or the
3961 * libtidy (PHP >= 5) extension to use an in-process tidy library instead
3962 * of spawning a separate program.
3963 * Normally you shouldn't need to override the setting except for
3964 * debugging. To install, use 'pear install tidy' and add a line
3965 * 'extension=tidy.so' to php.ini.
3972 $wgAlwaysUseTidy = false;
3977 $wgTidyBin = 'tidy';
3982 $wgTidyConf = $IP . '/includes/tidy.conf';
3992 $wgTidyInternal = extension_loaded( 'tidy' );
3995 * Put tidy warnings in HTML comments
3996 * Only works for internal tidy.
3998 $wgDebugTidy = false;
4001 * Allow raw, unchecked HTML in "<html>...</html>" sections.
4002 * THIS IS VERY DANGEROUS on a publicly editable site, so USE wgGroupPermissions
4003 * TO RESTRICT EDITING to only those that you trust
4008 * Set a default target for external links, e.g. _blank to pop up a new window
4010 $wgExternalLinkTarget = false;
4013 * If true, external URL links in wiki text will be given the
4014 * rel="nofollow" attribute as a hint to search engines that
4015 * they should not be followed for ranking purposes as they
4016 * are user-supplied and thus subject to spamming.
4018 $wgNoFollowLinks = true;
4021 * Namespaces in which $wgNoFollowLinks doesn't apply.
4022 * See Language.php for a list of namespaces.
4024 $wgNoFollowNsExceptions = array();
4027 * If this is set to an array of domains, external links to these domain names
4028 * (or any subdomains) will not be set to rel="nofollow" regardless of the
4029 * value of $wgNoFollowLinks. For instance:
4031 * $wgNoFollowDomainExceptions = array( 'en.wikipedia.org', 'wiktionary.org',
4032 * 'mediawiki.org' );
4034 * This would add rel="nofollow" to links to de.wikipedia.org, but not
4035 * en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org,
4038 * Defaults to mediawiki.org for the links included in the software by default.
4040 $wgNoFollowDomainExceptions = array( 'mediawiki.org' );
4043 * Allow DISPLAYTITLE to change title display
4045 $wgAllowDisplayTitle = true;
4048 * For consistency, restrict DISPLAYTITLE to text that normalizes to the same
4049 * canonical DB key. Also disallow some inline CSS rules like display: none;
4050 * which can cause the text to be hidden or unselectable.
4052 $wgRestrictDisplayTitle = true;
4055 * Maximum number of calls per parse to expensive parser functions such as
4058 $wgExpensiveParserFunctionLimit = 100;
4061 * Preprocessor caching threshold
4062 * Setting it to 'false' will disable the preprocessor cache.
4064 $wgPreprocessorCacheThreshold = 1000;
4067 * Enable interwiki transcluding. Only when iw_trans=1 in the interwiki table.
4069 $wgEnableScaryTranscluding = false;
4072 * Expiry time for transcluded templates cached in transcache database table.
4073 * Only used $wgEnableInterwikiTranscluding is set to true.
4075 $wgTranscludeCacheExpiry = 3600;
4077 /** @} */ # end of parser settings }
4079 /************************************************************************//**
4085 * Method used to determine if a page in a content namespace should be counted
4086 * as a valid article.
4088 * Redirect pages will never be counted as valid articles.
4090 * This variable can have the following values:
4091 * - 'any': all pages as considered as valid articles
4092 * - 'comma': the page must contain a comma to be considered valid
4093 * - 'link': the page must contain a [[wiki link]] to be considered valid
4095 * See also See https://www.mediawiki.org/wiki/Manual:Article_count
4097 * Retroactively changing this variable will not affect the existing count,
4098 * to update it, you will need to run the maintenance/updateArticleCount.php
4101 $wgArticleCountMethod = 'link';
4104 * wgHitcounterUpdateFreq sets how often page counters should be updated, higher
4105 * values are easier on the database. A value of 1 causes the counters to be
4106 * updated on every hit, any higher value n cause them to update *on average*
4107 * every n hits. Should be set to either 1 or something largish, eg 1000, for
4108 * maximum efficiency.
4110 $wgHitcounterUpdateFreq = 1;
4113 * How many days user must be idle before he is considered inactive. Will affect
4114 * the number shown on Special:Statistics, Special:ActiveUsers, and the
4115 * {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
4116 * You might want to leave this as the default value, to provide comparable
4117 * numbers between different wikis.
4119 $wgActiveUserDays = 30;
4121 /** @} */ # End of statistics }
4123 /************************************************************************//**
4124 * @name User accounts, authentication
4129 * For compatibility with old installations set to false
4130 * @deprecated since 1.24 will be removed in future
4132 $wgPasswordSalt = true;
4135 * Specifies the minimal length of a user password. If set to 0, empty pass-
4136 * words are allowed.
4138 $wgMinimalPasswordLength = 1;
4141 * Specifies if users should be sent to a password-reset form on login, if their
4142 * password doesn't meet the requirements of User::isValidPassword().
4145 $wgInvalidPasswordReset = true;
4148 * Default password type to use when hashing user passwords
4152 $wgPasswordDefault = 'pbkdf2';
4155 * Configuration for built-in password types. Maps the password type
4156 * to an array of options. The 'class' option is the Password class to
4157 * use. All other options are class-dependent.
4159 * An advanced example:
4161 * $wgPasswordConfig['bcrypt-peppered'] = array(
4162 * 'class' => 'EncryptedPassword',
4163 * 'underlying' => 'bcrypt',
4164 * 'secrets' => array(),
4165 * 'cipher' => MCRYPT_RIJNDAEL_256,
4166 * 'mode' => MCRYPT_MODE_CBC,
4173 $wgPasswordConfig = array(
4175 'class' => 'MWOldPassword',
4178 'class' => 'MWSaltedPassword',
4180 'pbkdf2-legacyA' => array(
4181 'class' => 'LayeredParameterizedPassword',
4187 'pbkdf2-legacyB' => array(
4188 'class' => 'LayeredParameterizedPassword',
4195 'class' => 'BcryptPassword',
4199 'class' => 'Pbkdf2Password',
4207 * Whether to allow password resets ("enter some identifying data, and we'll send an email
4208 * with a temporary password you can use to get back into the account") identified by
4209 * various bits of data. Setting all of these to false (or the whole variable to false)
4210 * has the effect of disabling password resets entirely
4212 $wgPasswordResetRoutes = array(
4218 * Maximum number of Unicode characters in signature
4220 $wgMaxSigChars = 255;
4223 * Maximum number of bytes in username. You want to run the maintenance
4224 * script ./maintenance/checkUsernames.php once you have changed this value.
4226 $wgMaxNameChars = 255;
4229 * Array of usernames which may not be registered or logged in from
4230 * Maintenance scripts can still use these
4232 $wgReservedUsernames = array(
4233 'MediaWiki default', // Default 'Main Page' and MediaWiki: message pages
4234 'Conversion script', // Used for the old Wikipedia software upgrade
4235 'Maintenance script', // Maintenance scripts which perform editing, image import script
4236 'Template namespace initialisation script', // Used in 1.2->1.3 upgrade
4237 'ScriptImporter', // Default user name used by maintenance/importSiteScripts.php
4238 'msg:double-redirect-fixer', // Automatic double redirect fix
4239 'msg:usermessage-editor', // Default user for leaving user messages
4240 'msg:proxyblocker', // For $wgProxyList and Special:Blockme (removed in 1.22)
4244 * Settings added to this array will override the default globals for the user
4245 * preferences used by anonymous visitors and newly created accounts.
4246 * For instance, to disable editing on double clicks:
4247 * $wgDefaultUserOptions ['editondblclick'] = 0;
4249 $wgDefaultUserOptions = array(
4250 'ccmeonemails' => 0,
4252 'date' => 'default',
4255 'editfont' => 'default',
4256 'editondblclick' => 0,
4257 'editsectiononrightclick' => 0,
4258 'enotifminoredits' => 0,
4259 'enotifrevealaddr' => 0,
4260 'enotifusertalkpages' => 1,
4261 'enotifwatchlistpages' => 1,
4262 'extendwatchlist' => 0,
4264 'forceeditsummary' => 0,
4265 'gender' => 'unknown',
4267 'hidepatrolled' => 0,
4270 'minordefault' => 0,
4271 'newpageshidepatrolled' => 0,
4273 'norollbackdiff' => 0,
4274 'numberheadings' => 0,
4275 'previewonfirst' => 0,
4276 'previewontop' => 1,
4280 'showhiddencats' => 0,
4281 'shownumberswatching' => 1,
4284 'stubthreshold' => 0,
4287 'uselivepreview' => 0,
4289 'watchcreations' => 1,
4290 'watchdefault' => 1,
4291 'watchdeletion' => 0,
4292 'watchlistdays' => 3.0,
4293 'watchlisthideanons' => 0,
4294 'watchlisthidebots' => 0,
4295 'watchlisthideliu' => 0,
4296 'watchlisthideminor' => 0,
4297 'watchlisthideown' => 0,
4298 'watchlisthidepatrolled' => 0,
4300 'watchrollback' => 0,
4302 'useeditwarning' => 1,
4303 'prefershttps' => 1,
4307 * An array of preferences to not show for the user
4309 $wgHiddenPrefs = array();
4312 * Characters to prevent during new account creations.
4313 * This is used in a regular expression character class during
4314 * registration (regex metacharacters like / are escaped).
4316 $wgInvalidUsernameCharacters = '@';
4319 * Character used as a delimiter when testing for interwiki userrights
4320 * (In Special:UserRights, it is possible to modify users on different
4321 * databases if the delimiter is used, e.g. "Someuser@enwiki").
4323 * It is recommended that you have this delimiter in
4324 * $wgInvalidUsernameCharacters above, or you will not be able to
4325 * modify the user rights of those users via Special:UserRights
4327 $wgUserrightsInterwikiDelimiter = '@';
4330 * This is to let user authenticate using https when they come from http.
4331 * Based on an idea by George Herbert on wikitech-l:
4332 * http://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
4335 $wgSecureLogin = false;
4337 /** @} */ # end user accounts }
4339 /************************************************************************//**
4340 * @name User rights, access control and monitoring
4345 * Number of seconds before autoblock entries expire. Default 86400 = 1 day.
4347 $wgAutoblockExpiry = 86400;
4350 * Set this to true to allow blocked users to edit their own user talk page.
4352 $wgBlockAllowsUTEdit = false;
4355 * Allow sysops to ban users from accessing Emailuser
4357 $wgSysopEmailBans = true;
4360 * Limits on the possible sizes of range blocks.
4362 * CIDR notation is hard to understand, it's easy to mistakenly assume that a
4363 * /1 is a small range and a /31 is a large range. For IPv4, setting a limit of
4364 * half the number of bits avoids such errors, and allows entire ISPs to be
4365 * blocked using a small number of range blocks.
4367 * For IPv6, RFC 3177 recommends that a /48 be allocated to every residential
4368 * customer, so range blocks larger than /64 (half the number of bits) will
4369 * plainly be required. RFC 4692 implies that a very large ISP may be
4370 * allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that
4371 * as our limit. As of 2012, blocking the whole world would require a /4 range.
4373 $wgBlockCIDRLimit = array(
4374 'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
4379 * If true, blocked users will not be allowed to login. When using this with
4380 * a public wiki, the effect of logging out blocked users may actually be
4381 * avers: unless the user's address is also blocked (e.g. auto-block),
4382 * logging the user out will again allow reading and editing, just as for
4383 * anonymous visitors.
4385 $wgBlockDisablesLogin = false;
4388 * Pages anonymous user may see, set as an array of pages titles.
4392 * $wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");
4395 * Special:Userlogin and Special:ChangePassword are always whitelisted.
4397 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4398 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4400 * @note Also that this will only protect _pages in the wiki_. Uploaded files
4401 * will remain readable. You can use img_auth.php to protect uploaded files,
4402 * see https://www.mediawiki.org/wiki/Manual:Image_Authorization
4404 $wgWhitelistRead = false;
4407 * Pages anonymous user may see, set as an array of regular expressions.
4409 * This function will match the regexp against the title name, which
4410 * is without underscore.
4413 * To whitelist [[Main Page]]:
4415 * $wgWhitelistReadRegexp = array( "/Main Page/" );
4418 * @note Unless ^ and/or $ is specified, a regular expression might match
4419 * pages not intended to be whitelisted. The above example will also
4420 * whitelist a page named 'Security Main Page'.
4423 * To allow reading any page starting with 'User' regardless of the case:
4425 * $wgWhitelistReadRegexp = array( "@^UsEr.*@i" );
4427 * Will allow both [[User is banned]] and [[User:JohnDoe]]
4429 * @note This will only work if $wgGroupPermissions['*']['read'] is false --
4430 * see below. Otherwise, ALL pages are accessible, regardless of this setting.
4432 $wgWhitelistReadRegexp = false;
4435 * Should editors be required to have a validated e-mail
4436 * address before being allowed to edit?
4438 $wgEmailConfirmToEdit = false;
4441 * Permission keys given to users in each group.
4443 * This is an array where the keys are all groups and each value is an
4444 * array of the format (right => boolean).
4446 * The second format is used to support per-namespace permissions.
4447 * Note that this feature does not fully work for all permission types.
4449 * All users are implicitly in the '*' group including anonymous visitors;
4450 * logged-in users are all implicitly in the 'user' group. These will be
4451 * combined with the permissions of all groups that a given user is listed
4452 * in in the user_groups table.
4454 * Note: Don't set $wgGroupPermissions = array(); unless you know what you're
4455 * doing! This will wipe all permissions, and may mean that your users are
4456 * unable to perform certain essential tasks or access new functionality
4457 * when new permissions are introduced and default grants established.
4459 * Functionality to make pages inaccessible has not been extensively tested
4460 * for security. Use at your own risk!
4462 * This replaces $wgWhitelistAccount and $wgWhitelistEdit
4464 $wgGroupPermissions = array();
4466 /** @cond file_level_code */
4467 // Implicit group for all visitors
4468 $wgGroupPermissions['*']['createaccount'] = true;
4469 $wgGroupPermissions['*']['read'] = true;
4470 $wgGroupPermissions['*']['edit'] = true;
4471 $wgGroupPermissions['*']['createpage'] = true;
4472 $wgGroupPermissions['*']['createtalk'] = true;
4473 $wgGroupPermissions['*']['writeapi'] = true;
4474 $wgGroupPermissions['*']['editmyusercss'] = true;
4475 $wgGroupPermissions['*']['editmyuserjs'] = true;
4476 $wgGroupPermissions['*']['viewmywatchlist'] = true;
4477 $wgGroupPermissions['*']['editmywatchlist'] = true;
4478 $wgGroupPermissions['*']['viewmyprivateinfo'] = true;
4479 $wgGroupPermissions['*']['editmyprivateinfo'] = true;
4480 $wgGroupPermissions['*']['editmyoptions'] = true;
4481 #$wgGroupPermissions['*']['patrolmarks'] = false; // let anons see what was patrolled
4483 // Implicit group for all logged-in accounts
4484 $wgGroupPermissions['user']['move'] = true;
4485 $wgGroupPermissions['user']['move-subpages'] = true;
4486 $wgGroupPermissions['user']['move-rootuserpages'] = true; // can move root userpages
4487 $wgGroupPermissions['user']['move-categorypages'] = true;
4488 $wgGroupPermissions['user']['movefile'] = true;
4489 $wgGroupPermissions['user']['read'] = true;
4490 $wgGroupPermissions['user']['edit'] = true;
4491 $wgGroupPermissions['user']['createpage'] = true;
4492 $wgGroupPermissions['user']['createtalk'] = true;
4493 $wgGroupPermissions['user']['writeapi'] = true;
4494 $wgGroupPermissions['user']['upload'] = true;
4495 $wgGroupPermissions['user']['reupload'] = true;
4496 $wgGroupPermissions['user']['reupload-shared'] = true;
4497 $wgGroupPermissions['user']['minoredit'] = true;
4498 $wgGroupPermissions['user']['purge'] = true; // can use ?action=purge without clicking "ok"
4499 $wgGroupPermissions['user']['sendemail'] = true;
4501 // Implicit group for accounts that pass $wgAutoConfirmAge
4502 $wgGroupPermissions['autoconfirmed']['autoconfirmed'] = true;
4503 $wgGroupPermissions['autoconfirmed']['editsemiprotected'] = true;
4505 // Users with bot privilege can have their edits hidden
4506 // from various log pages by default
4507 $wgGroupPermissions['bot']['bot'] = true;
4508 $wgGroupPermissions['bot']['autoconfirmed'] = true;
4509 $wgGroupPermissions['bot']['editsemiprotected'] = true;
4510 $wgGroupPermissions['bot']['nominornewtalk'] = true;
4511 $wgGroupPermissions['bot']['autopatrol'] = true;
4512 $wgGroupPermissions['bot']['suppressredirect'] = true;
4513 $wgGroupPermissions['bot']['apihighlimits'] = true;
4514 $wgGroupPermissions['bot']['writeapi'] = true;
4516 // Most extra permission abilities go to this group
4517 $wgGroupPermissions['sysop']['block'] = true;
4518 $wgGroupPermissions['sysop']['createaccount'] = true;
4519 $wgGroupPermissions['sysop']['delete'] = true;
4520 // can be separately configured for pages with > $wgDeleteRevisionsLimit revs
4521 $wgGroupPermissions['sysop']['bigdelete'] = true;
4522 // can view deleted history entries, but not see or restore the text
4523 $wgGroupPermissions['sysop']['deletedhistory'] = true;
4524 // can view deleted revision text
4525 $wgGroupPermissions['sysop']['deletedtext'] = true;
4526 $wgGroupPermissions['sysop']['undelete'] = true;
4527 $wgGroupPermissions['sysop']['editinterface'] = true;
4528 $wgGroupPermissions['sysop']['editusercss'] = true;
4529 $wgGroupPermissions['sysop']['edituserjs'] = true;
4530 $wgGroupPermissions['sysop']['import'] = true;
4531 $wgGroupPermissions['sysop']['importupload'] = true;
4532 $wgGroupPermissions['sysop']['move'] = true;
4533 $wgGroupPermissions['sysop']['move-subpages'] = true;
4534 $wgGroupPermissions['sysop']['move-rootuserpages'] = true;
4535 $wgGroupPermissions['sysop']['move-categorypages'] = true;
4536 $wgGroupPermissions['sysop']['patrol'] = true;
4537 $wgGroupPermissions['sysop']['autopatrol'] = true;
4538 $wgGroupPermissions['sysop']['protect'] = true;
4539 $wgGroupPermissions['sysop']['editprotected'] = true;
4540 $wgGroupPermissions['sysop']['proxyunbannable'] = true;
4541 $wgGroupPermissions['sysop']['rollback'] = true;
4542 $wgGroupPermissions['sysop']['upload'] = true;
4543 $wgGroupPermissions['sysop']['reupload'] = true;
4544 $wgGroupPermissions['sysop']['reupload-shared'] = true;
4545 $wgGroupPermissions['sysop']['unwatchedpages'] = true;
4546 $wgGroupPermissions['sysop']['autoconfirmed'] = true;
4547 $wgGroupPermissions['sysop']['editsemiprotected'] = true;
4548 $wgGroupPermissions['sysop']['ipblock-exempt'] = true;
4549 $wgGroupPermissions['sysop']['blockemail'] = true;
4550 $wgGroupPermissions['sysop']['markbotedits'] = true;
4551 $wgGroupPermissions['sysop']['apihighlimits'] = true;
4552 $wgGroupPermissions['sysop']['browsearchive'] = true;
4553 $wgGroupPermissions['sysop']['noratelimit'] = true;
4554 $wgGroupPermissions['sysop']['movefile'] = true;
4555 $wgGroupPermissions['sysop']['unblockself'] = true;
4556 $wgGroupPermissions['sysop']['suppressredirect'] = true;
4557 #$wgGroupPermissions['sysop']['pagelang'] = true;
4558 #$wgGroupPermissions['sysop']['upload_by_url'] = true;
4559 $wgGroupPermissions['sysop']['mergehistory'] = true;
4561 // Permission to change users' group assignments
4562 $wgGroupPermissions['bureaucrat']['userrights'] = true;
4563 $wgGroupPermissions['bureaucrat']['noratelimit'] = true;
4564 // Permission to change users' groups assignments across wikis
4565 #$wgGroupPermissions['bureaucrat']['userrights-interwiki'] = true;
4566 // Permission to export pages including linked pages regardless of $wgExportMaxLinkDepth
4567 #$wgGroupPermissions['bureaucrat']['override-export-depth'] = true;
4569 #$wgGroupPermissions['sysop']['deletelogentry'] = true;
4570 #$wgGroupPermissions['sysop']['deleterevision'] = true;
4571 // To hide usernames from users and Sysops
4572 #$wgGroupPermissions['suppress']['hideuser'] = true;
4573 // To hide revisions/log items from users and Sysops
4574 #$wgGroupPermissions['suppress']['suppressrevision'] = true;
4575 // To view revisions/log items hidden from users and Sysops
4576 #$wgGroupPermissions['suppress']['viewsuppressed'] = true;
4577 // For private suppression log access
4578 #$wgGroupPermissions['suppress']['suppressionlog'] = true;
4581 * The developer group is deprecated, but can be activated if need be
4582 * to use the 'lockdb' and 'unlockdb' special pages. Those require
4583 * that a lock file be defined and creatable/removable by the web
4586 # $wgGroupPermissions['developer']['siteadmin'] = true;
4591 * Permission keys revoked from users in each group.
4593 * This acts the same way as wgGroupPermissions above, except that
4594 * if the user is in a group here, the permission will be removed from them.
4596 * Improperly setting this could mean that your users will be unable to perform
4597 * certain essential tasks, so use at your own risk!
4599 $wgRevokePermissions = array();
4602 * Implicit groups, aren't shown on Special:Listusers or somewhere else
4604 $wgImplicitGroups = array( '*', 'user', 'autoconfirmed' );
4607 * A map of group names that the user is in, to group names that those users
4608 * are allowed to add or revoke.
4610 * Setting the list of groups to add or revoke to true is equivalent to "any
4614 * To allow sysops to add themselves to the "bot" group:
4616 * $wgGroupsAddToSelf = array( 'sysop' => array( 'bot' ) );
4620 * Implicit groups may be used for the source group, for instance:
4622 * $wgGroupsRemoveFromSelf = array( '*' => true );
4624 * This allows users in the '*' group (i.e. any user) to remove themselves from
4625 * any group that they happen to be in.
4627 $wgGroupsAddToSelf = array();
4630 * @see $wgGroupsAddToSelf
4632 $wgGroupsRemoveFromSelf = array();
4635 * Set of available actions that can be restricted via action=protect
4636 * You probably shouldn't change this.
4637 * Translated through restriction-* messages.
4638 * Title::getRestrictionTypes() will remove restrictions that are not
4639 * applicable to a specific title (create and upload)
4641 $wgRestrictionTypes = array( 'create', 'edit', 'move', 'upload' );
4644 * Rights which can be required for each protection level (via action=protect)
4646 * You can add a new protection level that requires a specific
4647 * permission by manipulating this array. The ordering of elements
4648 * dictates the order on the protection form's lists.
4650 * - '' will be ignored (i.e. unprotected)
4651 * - 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
4652 * - 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility
4654 $wgRestrictionLevels = array( '', 'autoconfirmed', 'sysop' );
4657 * Restriction levels that can be used with cascading protection
4659 * A page can only be protected with cascading protection if the
4660 * requested restriction level is included in this array.
4662 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4663 * 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
4665 $wgCascadingRestrictionLevels = array( 'sysop' );
4668 * Restriction levels that should be considered "semiprotected"
4670 * Certain places in the interface recognize a dichotomy between "protected"
4671 * and "semiprotected", without further distinguishing the specific levels. In
4672 * general, if anyone can be eligible to edit a protection level merely by
4673 * reaching some condition in $wgAutopromote, it should probably be considered
4676 * 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility.
4677 * 'sysop' is not changed, since it really shouldn't be here.
4679 $wgSemiprotectedRestrictionLevels = array( 'autoconfirmed' );
4682 * Set the minimum permissions required to edit pages in each
4683 * namespace. If you list more than one permission, a user must
4684 * have all of them to edit pages in that namespace.
4686 * @note NS_MEDIAWIKI is implicitly restricted to 'editinterface'.
4688 $wgNamespaceProtection = array();
4691 * Pages in namespaces in this array can not be used as templates.
4693 * Elements MUST be numeric namespace ids, you can safely use the MediaWiki
4694 * namespaces constants (NS_USER, NS_MAIN...).
4696 * Among other things, this may be useful to enforce read-restrictions
4697 * which may otherwise be bypassed by using the template mechanism.
4699 $wgNonincludableNamespaces = array();
4702 * Number of seconds an account is required to age before it's given the
4703 * implicit 'autoconfirm' group membership. This can be used to limit
4704 * privileges of new accounts.
4706 * Accounts created by earlier versions of the software may not have a
4707 * recorded creation date, and will always be considered to pass the age test.
4709 * When left at 0, all registered accounts will pass.
4712 * Set automatic confirmation to 10 minutes (which is 600 seconds):
4714 * $wgAutoConfirmAge = 600; // ten minutes
4716 * Set age to one day:
4718 * $wgAutoConfirmAge = 3600*24; // one day
4721 $wgAutoConfirmAge = 0;
4724 * Number of edits an account requires before it is autoconfirmed.
4725 * Passing both this AND the time requirement is needed. Example:
4729 * $wgAutoConfirmCount = 50;
4732 $wgAutoConfirmCount = 0;
4735 * Automatically add a usergroup to any user who matches certain conditions.
4737 * @todo Redocument $wgAutopromote
4740 * array( '&' or '|' or '^' or '!', cond1, cond2, ... )
4741 * where cond1, cond2, ... are themselves conditions; *OR*
4742 * APCOND_EMAILCONFIRMED, *OR*
4743 * array( APCOND_EMAILCONFIRMED ), *OR*
4744 * array( APCOND_EDITCOUNT, number of edits ), *OR*
4745 * array( APCOND_AGE, seconds since registration ), *OR*
4746 * array( APCOND_INGROUPS, group1, group2, ... ), *OR*
4747 * array( APCOND_ISIP, ip ), *OR*
4748 * array( APCOND_IPINRANGE, range ), *OR*
4749 * array( APCOND_AGE_FROM_EDIT, seconds since first edit ), *OR*
4750 * array( APCOND_BLOCKED ), *OR*
4751 * array( APCOND_ISBOT ), *OR*
4752 * similar constructs defined by extensions.
4754 * If $wgEmailAuthentication is off, APCOND_EMAILCONFIRMED will be true for any
4755 * user who has provided an e-mail address.
4757 $wgAutopromote = array(
4758 'autoconfirmed' => array( '&',
4759 array( APCOND_EDITCOUNT
, &$wgAutoConfirmCount ),
4760 array( APCOND_AGE
, &$wgAutoConfirmAge ),
4765 * Automatically add a usergroup to any user who matches certain conditions.
4767 * Does not add the user to the group again if it has been removed.
4768 * Also, does not remove the group if the user no longer meets the criteria.
4772 * array( event => criteria, ... )
4774 * Where event is either:
4775 * - 'onEdit' (when user edits)
4776 * - 'onView' (when user views the wiki)
4778 * Criteria has the same format as $wgAutopromote
4780 * @see $wgAutopromote
4783 $wgAutopromoteOnce = array(
4784 'onEdit' => array(),
4789 * Put user rights log entries for autopromotion in recent changes?
4792 $wgAutopromoteOnceLogInRC = true;
4795 * $wgAddGroups and $wgRemoveGroups can be used to give finer control over who
4796 * can assign which groups at Special:Userrights.
4799 * Bureaucrats can add any group:
4801 * $wgAddGroups['bureaucrat'] = true;
4803 * Bureaucrats can only remove bots and sysops:
4805 * $wgRemoveGroups['bureaucrat'] = array( 'bot', 'sysop' );
4807 * Sysops can make bots:
4809 * $wgAddGroups['sysop'] = array( 'bot' );
4811 * Sysops can disable other sysops in an emergency, and disable bots:
4813 * $wgRemoveGroups['sysop'] = array( 'sysop', 'bot' );
4816 $wgAddGroups = array();
4821 $wgRemoveGroups = array();
4824 * A list of available rights, in addition to the ones defined by the core.
4825 * For extensions only.
4827 $wgAvailableRights = array();
4830 * Optional to restrict deletion of pages with higher revision counts
4831 * to users with the 'bigdelete' permission. (Default given to sysops.)
4833 $wgDeleteRevisionsLimit = 0;
4836 * The maximum number of edits a user can have and
4837 * can still be hidden by users with the hideuser permission.
4838 * This is limited for performance reason.
4839 * Set to false to disable the limit.
4842 $wgHideUserContribLimit = 1000;
4845 * Number of accounts each IP address may create, 0 to disable.
4847 * @warning Requires memcached
4849 $wgAccountCreationThrottle = 0;
4852 * Edits matching these regular expressions in body text
4853 * will be recognised as spam and rejected automatically.
4855 * There's no administrator override on-wiki, so be careful what you set. :)
4856 * May be an array of regexes or a single string for backwards compatibility.
4858 * @see http://en.wikipedia.org/wiki/Regular_expression
4860 * @note Each regex needs a beginning/end delimiter, eg: # or /
4862 $wgSpamRegex = array();
4865 * Same as the above except for edit summaries
4867 $wgSummarySpamRegex = array();
4870 * Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open
4874 $wgEnableDnsBlacklist = false;
4877 * List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
4879 * This is an array of either a URL or an array with the URL and a key (should
4880 * the blacklist require a key).
4884 * $wgDnsBlacklistUrls = array(
4885 * // String containing URL
4886 * 'http.dnsbl.sorbs.net.',
4887 * // Array with URL and key, for services that require a key
4888 * array( 'dnsbl.httpbl.net.', 'mykey' ),
4889 * // Array with just the URL. While this works, it is recommended that you
4890 * // just use a string as shown above
4891 * array( 'opm.tornevall.org.' )
4895 * @note You should end the domain name with a . to avoid searching your
4896 * eventual domain search suffixes.
4899 $wgDnsBlacklistUrls = array( 'http.dnsbl.sorbs.net.' );
4902 * Proxy whitelist, list of addresses that are assumed to be non-proxy despite
4903 * what the other methods might say.
4905 $wgProxyWhitelist = array();
4908 * Whether to look at the X-Forwarded-For header's list of (potentially spoofed)
4909 * IPs and apply IP blocks to them. This allows for IP blocks to work with correctly-configured
4910 * (transparent) proxies without needing to block the proxies themselves.
4912 $wgApplyIpBlocksToXff = false;
4915 * Simple rate limiter options to brake edit floods.
4917 * Maximum number actions allowed in the given number of seconds; after that
4918 * the violating client receives HTTP 500 error pages until the period
4922 * To set a generic maximum of 4 hits in 60 seconds:
4924 * $wgRateLimits = array( 4, 60 );
4927 * You could also limit per action and then type of users. See the inline
4928 * code for a template to use.
4930 * This option set is experimental and likely to change.
4932 * @warning Requires memcached.
4934 $wgRateLimits = array(
4936 'anon' => null, // for any and all anonymous edits (aggregate)
4937 'user' => null, // for each logged-in user
4938 'newbie' => null, // for each recent (autoconfirmed) account; overrides 'user'
4939 'ip' => null, // for each anon and recent account
4940 'subnet' => null, // ... within a /24 subnet in IPv4 or /64 in IPv6
4948 'mailpassword' => array( // triggering password resets emails
4951 'emailuser' => array( // emailing other users using MediaWiki
4954 'linkpurge' => array( // purges of link tables
4961 'renderfile' => array( // files rendered via thumb.php or thumb_handler.php
4968 'renderfile-nonstandard' => array( // same as above but for non-standard thumbnails
4978 * Set to a filename to log rate limiter hits.
4980 * @deprecated since 1.23, use $wgDebugLogGroups['ratelimit'] instead
4982 $wgRateLimitLog = null;
4985 * Array of IPs which should be excluded from rate limits.
4986 * This may be useful for whitelisting NAT gateways for conferences, etc.
4988 $wgRateLimitsExcludedIPs = array();
4991 * Log IP addresses in the recentchanges table; can be accessed only by
4992 * extensions (e.g. CheckUser) or a DB admin
4993 * Used for retroactive autoblocks
4995 $wgPutIPinRC = true;
4998 * Integer defining default number of entries to show on
4999 * special pages which are query-pages such as Special:Whatlinkshere.
5001 $wgQueryPageDefaultLimit = 50;
5004 * Limit password attempts to X attempts per Y seconds per IP per account.
5006 * @warning Requires memcached.
5008 $wgPasswordAttemptThrottle = array( 'count' => 5, 'seconds' => 300 );
5010 /** @} */ # end of user rights settings
5012 /************************************************************************//**
5013 * @name Proxy scanner settings
5018 * This should always be customised in LocalSettings.php
5020 $wgSecretKey = false;
5023 * Big list of banned IP addresses.
5025 * This can have the following formats:
5026 * - An array of addresses, either in the values
5027 * or the keys (for backward compatibility)
5028 * - A string, in that case this is the path to a file
5029 * containing the list of IP addresses, one per line
5031 $wgProxyList = array();
5033 /** @} */ # end of proxy scanner settings
5035 /************************************************************************//**
5036 * @name Cookie settings
5041 * Default cookie lifetime, in seconds. Setting to 0 makes all cookies session-only.
5043 $wgCookieExpiration = 180 * 86400;
5046 * Set to set an explicit domain on the login cookies eg, "justthis.domain.org"
5047 * or ".any.subdomain.net"
5049 $wgCookieDomain = '';
5052 * Set this variable if you want to restrict cookies to a certain path within
5053 * the domain specified by $wgCookieDomain.
5055 $wgCookiePath = '/';
5058 * Whether the "secure" flag should be set on the cookie. This can be:
5059 * - true: Set secure flag
5060 * - false: Don't set secure flag
5061 * - "detect": Set the secure flag if $wgServer is set to an HTTPS URL
5063 $wgCookieSecure = 'detect';
5066 * By default, MediaWiki checks if the client supports cookies during the
5067 * login process, so that it can display an informative error message if
5068 * cookies are disabled. Set this to true if you want to disable this cookie
5071 $wgDisableCookieCheck = false;
5074 * Cookies generated by MediaWiki have names starting with this prefix. Set it
5075 * to a string to use a custom prefix. Setting it to false causes the database
5076 * name to be used as a prefix.
5078 $wgCookiePrefix = false;
5081 * Set authentication cookies to HttpOnly to prevent access by JavaScript,
5082 * in browsers that support this feature. This can mitigates some classes of
5085 $wgCookieHttpOnly = true;
5088 * A list of cookies that vary the cache (for use by extensions)
5090 $wgCacheVaryCookies = array();
5093 * Override to customise the session name
5095 $wgSessionName = false;
5097 /** @} */ # end of cookie settings }
5099 /************************************************************************//**
5100 * @name LaTeX (mathematical formulas)
5105 * To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of
5106 * the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert
5107 * (ImageMagick) installed and available in the PATH.
5108 * Please see math/README for more information.
5112 /** @} */ # end LaTeX }
5114 /************************************************************************//**
5115 * @name Profiling, testing and debugging
5117 * To enable profiling, edit StartProfiler.php
5123 * Filename for debug logging. See https://www.mediawiki.org/wiki/How_to_debug
5124 * The debug log file should be not be publicly accessible if it is used, as it
5125 * may contain private data.
5127 $wgDebugLogFile = '';
5130 * Prefix for debug log lines
5132 $wgDebugLogPrefix = '';
5135 * If true, instead of redirecting, show a page with a link to the redirect
5136 * destination. This allows for the inspection of PHP error messages, and easy
5137 * resubmission of form data. For developer use only.
5139 $wgDebugRedirects = false;
5142 * If true, log debugging data from action=raw and load.php.
5143 * This is normally false to avoid overlapping debug entries due to gen=css
5144 * and gen=js requests.
5146 $wgDebugRawPage = false;
5149 * Send debug data to an HTML comment in the output.
5151 * This may occasionally be useful when supporting a non-technical end-user.
5152 * It's more secure than exposing the debug log file to the web, since the
5153 * output only contains private data for the current user. But it's not ideal
5154 * for development use since data is lost on fatal errors and redirects.
5156 $wgDebugComments = false;
5159 * Extensive database transaction state debugging
5163 $wgDebugDBTransactions = false;
5166 * Write SQL queries to the debug log.
5168 * This setting is only used $wgLBFactoryConf['class'] is set to
5169 * 'LBFactorySimple' and $wgDBservers is an empty array; otherwise
5170 * the DBO_DEBUG flag must be set in the 'flags' option of the database
5171 * connection to achieve the same functionality.
5173 $wgDebugDumpSql = false;
5176 * Trim logged SQL queries to this many bytes. Set 0/false/null to do no
5180 $wgDebugDumpSqlLength = 500;
5183 * Map of string log group names to log destinations.
5185 * If set, wfDebugLog() output for that group will go to that file instead
5186 * of the regular $wgDebugLogFile. Useful for enabling selective logging
5189 * Log destinations may be one of the following:
5190 * - false to completely remove from the output, including from $wgDebugLogFile.
5191 * - string values specifying a filename or URI.
5192 * - associative array mapping 'destination' key to the desired filename or URI.
5193 * The associative array may also contain a 'sample' key with an integer value,
5194 * specifying a sampling factor.
5198 * $wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
5201 * @par Advanced example:
5203 * $wgDebugLogGroups['memcached'] = (
5204 * 'destination' => '/var/log/mediawiki/memcached.log',
5205 * 'sample' => 1000, // log 1 message out of every 1,000.
5209 $wgDebugLogGroups = array();
5212 * Display debug data at the bottom of the main content area.
5214 * Useful for developers and technical users trying to working on a closed wiki.
5216 $wgShowDebug = false;
5219 * Prefix debug messages with relative timestamp. Very-poor man's profiler.
5220 * Since 1.19 also includes memory usage.
5222 $wgDebugTimestamps = false;
5225 * Print HTTP headers for every request in the debug information.
5227 $wgDebugPrintHttpHeaders = true;
5230 * Show the contents of $wgHooks in Special:Version
5232 $wgSpecialVersionShowHooks = false;
5235 * Whether to show "we're sorry, but there has been a database error" pages.
5236 * Displaying errors aids in debugging, but may display information useful
5239 $wgShowSQLErrors = false;
5242 * If set to true, uncaught exceptions will print a complete stack trace
5243 * to output. This should only be used for debugging, as it may reveal
5244 * private information in function parameters due to PHP's backtrace
5247 $wgShowExceptionDetails = false;
5250 * If true, show a backtrace for database errors
5252 * @note This setting only applies when connection errors and query errors are
5253 * reported in the normal manner. $wgShowExceptionDetails applies in other cases,
5254 * including those in which an uncaught exception is thrown from within the
5255 * exception handler.
5257 $wgShowDBErrorBacktrace = false;
5260 * If true, send the exception backtrace to the error log
5262 $wgLogExceptionBacktrace = true;
5265 * Expose backend server host names through the API and various HTML comments
5267 $wgShowHostnames = false;
5270 * Override server hostname detection with a hardcoded value.
5271 * Should be a string, default false.
5274 $wgOverrideHostname = false;
5277 * If set to true MediaWiki will throw notices for some possible error
5278 * conditions and for deprecated functions.
5280 $wgDevelopmentWarnings = false;
5283 * Release limitation to wfDeprecated warnings, if set to a release number
5284 * development warnings will not be generated for deprecations added in releases
5287 $wgDeprecationReleaseLimit = false;
5290 * Only record profiling info for pages that took longer than this
5292 $wgProfileLimit = 0.0;
5295 * Don't put non-profiling info into log file
5297 * @deprecated since 1.23, set the log file in
5298 * $wgDebugLogGroups['profileoutput'] instead.
5300 $wgProfileOnly = false;
5303 * If true, print a raw call tree instead of per-function report
5305 $wgProfileCallTree = false;
5308 * Should application server host be put into profiling table
5310 $wgProfilePerHost = false;
5313 * Host for UDP profiler.
5315 * The host should be running a daemon which can be obtained from MediaWiki
5317 * http://git.wikimedia.org/tree/operations%2Fsoftware.git/master/udpprofile
5319 $wgUDPProfilerHost = '127.0.0.1';
5322 * Port for UDP profiler.
5323 * @see $wgUDPProfilerHost
5325 $wgUDPProfilerPort = '3811';
5328 * Format string for the UDP profiler. The UDP profiler invokes sprintf() with
5329 * (profile id, count, cpu, cpu_sq, real, real_sq, entry name, memory) as
5330 * arguments. You can use sprintf's argument numbering/swapping capability to
5331 * repeat, re-order or omit fields.
5333 * @see $wgStatsFormatString
5336 $wgUDPProfilerFormatString = "%s - %d %f %f %f %f %s\n";
5339 * Output debug message on every wfProfileIn/wfProfileOut
5341 $wgDebugFunctionEntry = false;
5344 * Destination for wfIncrStats() data...
5345 * 'cache' to go into the system cache, if enabled (memcached)
5346 * 'udp' to be sent to the UDP profiler (see $wgUDPProfilerHost)
5349 $wgStatsMethod = 'cache';
5352 * When $wgStatsMethod is 'udp', setting this to a string allows statistics to
5353 * be aggregated over more than one wiki. The string will be used in place of
5354 * the DB name in outgoing UDP packets. If this is set to false, the DB name
5357 $wgAggregateStatsID = false;
5360 * When $wgStatsMethod is 'udp', this variable specifies how stats should be
5361 * formatted. Its value should be a format string suitable for a sprintf()
5362 * invocation with (id, count, key) arguments, where 'id' is either
5363 * $wgAggregateStatsID or the DB name, 'count' is the value by which the metric
5364 * is being incremented, and 'key' is the metric name.
5366 * @see $wgUDPProfilerFormatString
5367 * @see $wgAggregateStatsID
5370 $wgStatsFormatString = "stats/%s - %s 1 1 1 1 %s\n";
5373 * Whereas to count the number of time an article is viewed.
5374 * Does not work if pages are cached (for example with squid).
5376 $wgDisableCounters = false;
5379 * InfoAction retrieves a list of transclusion links (both to and from).
5380 * This number puts a limit on that query in the case of highly transcluded
5383 $wgPageInfoTransclusionLimit = 50;
5386 * Set this to an integer to only do synchronous site_stats updates
5387 * one every *this many* updates. The other requests go into pending
5388 * delta values in $wgMemc. Make sure that $wgMemc is a global cache.
5389 * If set to -1, updates *only* go to $wgMemc (useful for daemons).
5391 $wgSiteStatsAsyncFactor = false;
5394 * Parser test suite files to be run by parserTests.php when no specific
5395 * filename is passed to it.
5397 * Extensions may add their own tests to this array, or site-local tests
5398 * may be added via LocalSettings.php
5402 $wgParserTestFiles = array(
5403 "$IP/tests/parser/parserTests.txt",
5404 "$IP/tests/parser/extraParserTests.txt"
5408 * Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).
5410 $wgEnableJavaScriptTest = false;
5413 * Configuration for javascript testing.
5415 $wgJavaScriptTestConfig = array(
5417 // Page where documentation can be found relevant to the QUnit test suite being ran.
5418 // Used in the intro paragraph on [[Special:JavaScriptTest/qunit]] for the
5419 // documentation link in the "javascripttest-qunit-intro" message.
5420 'documentation' => '//www.mediawiki.org/wiki/Manual:JavaScript_unit_testing',
5421 // If you are submitting the QUnit test suite to a TestSwarm instance,
5422 // point this to the "inject.js" script of that instance. This is was registers
5423 // the QUnit hooks to extract the test results and push them back up into the
5424 // TestSwarm database.
5425 // @example 'http://localhost/testswarm/js/inject.js'
5426 // @example '//integration.mediawiki.org/testswarm/js/inject.js'
5427 'testswarm-injectjs' => false,
5432 * Overwrite the caching key prefix with custom value.
5435 $wgCachePrefix = false;
5438 * Display the new debugging toolbar. This also enables profiling on database
5439 * queries and other useful output.
5440 * Will disable file cache.
5444 $wgDebugToolbar = false;
5446 /** @} */ # end of profiling, testing and debugging }
5448 /************************************************************************//**
5454 * Set this to true to disable the full text search feature.
5456 $wgDisableTextSearch = false;
5459 * Set to true to have nicer highlighted text in search results,
5460 * by default off due to execution overhead
5462 $wgAdvancedSearchHighlighting = false;
5465 * Regexp to match word boundaries, defaults for non-CJK languages
5466 * should be empty for CJK since the words are not separate
5468 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]';
5471 * Template for OpenSearch suggestions, defaults to API action=opensearch
5473 * Sites with heavy load would typically have these point to a custom
5474 * PHP wrapper to avoid firing up mediawiki for every keystroke
5476 * Placeholders: {searchTerms}
5478 $wgOpenSearchTemplate = false;
5481 * Enable OpenSearch suggestions requested by MediaWiki. Set this to
5482 * false if you've disabled scripts that use api?action=opensearch and
5483 * want reduce load caused by cached scripts still pulling suggestions.
5484 * It will let the API fallback by responding with an empty array.
5486 $wgEnableOpenSearchSuggest = true;
5489 * Integer defining default number of entries to show on
5492 $wgOpenSearchDefaultLimit = 10;
5495 * Expiry time for search suggestion responses
5497 $wgSearchSuggestCacheExpiry = 1200;
5500 * If you've disabled search semi-permanently, this also disables updates to the
5501 * table. If you ever re-enable, be sure to rebuild the search table.
5503 $wgDisableSearchUpdate = false;
5506 * List of namespaces which are searched by default.
5510 * $wgNamespacesToBeSearchedDefault[NS_MAIN] = true;
5511 * $wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;
5514 $wgNamespacesToBeSearchedDefault = array(
5519 * Disable the internal MySQL-based search, to allow it to be
5520 * implemented by an extension instead.
5522 $wgDisableInternalSearch = false;
5525 * Set this to a URL to forward search requests to some external location.
5526 * If the URL includes '$1', this will be replaced with the URL-encoded
5530 * To forward to Google you'd have something like:
5532 * $wgSearchForwardUrl =
5533 * 'http://www.google.com/search?q=$1' .
5534 * '&domains=http://example.com' .
5535 * '&sitesearch=http://example.com' .
5536 * '&ie=utf-8&oe=utf-8';
5539 $wgSearchForwardUrl = null;
5542 * Search form behavior.
5543 * - true = use Go & Search buttons
5544 * - false = use Go button & Advanced search link
5546 $wgUseTwoButtonsSearchForm = true;
5549 * Array of namespaces to generate a Google sitemap for when the
5550 * maintenance/generateSitemap.php script is run, or false if one is to be
5551 * generated for all namespaces.
5553 $wgSitemapNamespaces = false;
5556 * Custom namespace priorities for sitemaps. Setting this will allow you to
5557 * set custom priorities to namespaces when sitemaps are generated using the
5558 * maintenance/generateSitemap.php script.
5560 * This should be a map of namespace IDs to priority
5563 * $wgSitemapNamespacesPriorities = array(
5569 $wgSitemapNamespacesPriorities = false;
5572 * If true, searches for IP addresses will be redirected to that IP's
5573 * contributions page. E.g. searching for "1.2.3.4" will redirect to
5574 * [[Special:Contributions/1.2.3.4]]
5576 $wgEnableSearchContributorsByIP = true;
5578 /** @} */ # end of search settings
5580 /************************************************************************//**
5581 * @name Edit user interface
5586 * Path to the GNU diff3 utility. If the file doesn't exist, edit conflicts will
5587 * fall back to the old behavior (no merging).
5589 $wgDiff3 = '/usr/bin/diff3';
5592 * Path to the GNU diff utility.
5594 $wgDiff = '/usr/bin/diff';
5597 * Which namespaces have special treatment where they should be preview-on-open
5598 * Internally only Category: pages apply, but using this extensions (e.g. Semantic MediaWiki)
5599 * can specify namespaces of pages they have special treatment for
5601 $wgPreviewOnOpenNamespaces = array(
5606 * Go button goes straight to the edit screen if the article doesn't exist.
5608 $wgGoToEdit = false;
5611 * Enable the UniversalEditButton for browsers that support it
5612 * (currently only Firefox with an extension)
5613 * See http://universaleditbutton.org for more background information
5615 $wgUniversalEditButton = true;
5618 * If user doesn't specify any edit summary when making a an edit, MediaWiki
5619 * will try to automatically create one. This feature can be disabled by set-
5620 * ting this variable false.
5622 $wgUseAutomaticEditSummaries = true;
5624 /** @} */ # end edit UI }
5626 /************************************************************************//**
5628 * See also $wgSiteNotice
5633 * @cond file_level_code
5634 * Set $wgCommandLineMode if it's not set already, to avoid notices
5636 if ( !isset( $wgCommandLineMode ) ) {
5637 $wgCommandLineMode = false;
5642 * For colorized maintenance script output, is your terminal background dark ?
5644 $wgCommandLineDarkBg = false;
5647 * Set this to a string to put the wiki into read-only mode. The text will be
5648 * used as an explanation to users.
5650 * This prevents most write operations via the web interface. Cache updates may
5651 * still be possible. To prevent database writes completely, use the read_only
5657 * If this lock file exists (size > 0), the wiki will be forced into read-only mode.
5658 * Its contents will be shown to users as part of the read-only warning
5661 * Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php
5663 $wgReadOnlyFile = false;
5666 * When you run the web-based upgrade utility, it will tell you what to set
5667 * this to in order to authorize the upgrade process. It will subsequently be
5668 * used as a password, to authorize further upgrades.
5670 * For security, do not set this to a guessable string. Use the value supplied
5671 * by the install/upgrade process. To cause the upgrader to generate a new key,
5672 * delete the old key from LocalSettings.php.
5674 $wgUpgradeKey = false;
5677 * Fully specified path to git binary
5679 $wgGitBin = '/usr/bin/git';
5682 * Map GIT repository URLs to viewer URLs to provide links in Special:Version
5684 * Key is a pattern passed to preg_match() and preg_replace(),
5685 * without the delimiters (which are #) and must match the whole URL.
5686 * The value is the replacement for the key (it can contain $1, etc.)
5687 * %h will be replaced by the short SHA-1 (7 first chars) and %H by the
5688 * full SHA-1 of the HEAD revision.
5689 * %r will be replaced with a URL-encoded version of $1.
5693 $wgGitRepositoryViewers = array(
5694 'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' =>
5695 'https://git.wikimedia.org/tree/%r/%H',
5696 'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' =>
5697 'https://git.wikimedia.org/tree/%r/%H',
5700 /** @} */ # End of maintenance }
5702 /************************************************************************//**
5703 * @name Recent changes, new pages, watchlist and history
5708 * Recentchanges items are periodically purged; entries older than this many
5710 * Default: 13 weeks = about three months
5712 $wgRCMaxAge = 13 * 7 * 24 * 3600;
5715 * Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers
5716 * higher than what will be stored. Note that this is disabled by default
5717 * because we sometimes do have RC data which is beyond the limit for some
5718 * reason, and some users may use the high numbers to display that data which
5721 $wgRCFilterByAge = false;
5724 * List of Limits options to list in the Special:Recentchanges and
5725 * Special:Recentchangeslinked pages.
5727 $wgRCLinkLimits = array( 50, 100, 250, 500 );
5730 * List of Days options to list in the Special:Recentchanges and
5731 * Special:Recentchangeslinked pages.
5733 $wgRCLinkDays = array( 1, 3, 7, 14, 30 );
5736 * Destinations to which notifications about recent changes
5739 * As of MediaWiki 1.22, there are 2 supported 'engine' parameter option in core:
5740 * * 'UDPRCFeedEngine', which is used to send recent changes over UDP to the
5742 * * 'RedisPubSubFeedEngine', which is used to send recent changes to Redis.
5744 * The common options are:
5745 * * 'uri' -- the address to which the notices are to be sent.
5746 * * 'formatter' -- the class name (implementing RCFeedFormatter) which will
5747 * produce the text to send. This can also be an object of the class.
5748 * * 'omit_bots' -- whether the bot edits should be in the feed
5749 * * 'omit_anon' -- whether anonymous edits should be in the feed
5750 * * 'omit_user' -- whether edits by registered users should be in the feed
5751 * * 'omit_minor' -- whether minor edits should be in the feed
5752 * * 'omit_patrolled' -- whether patrolled edits should be in the feed
5754 * The IRC-specific options are:
5755 * * 'add_interwiki_prefix' -- whether the titles should be prefixed with
5756 * the first entry in the $wgLocalInterwikis array (or the value of
5757 * $wgLocalInterwiki, if set)
5759 * The JSON-specific options are:
5760 * * 'channel' -- if set, the 'channel' parameter is also set in JSON values.
5762 * @example $wgRCFeeds['example'] = array(
5763 * 'formatter' => 'JSONRCFeedFormatter',
5764 * 'uri' => "udp://localhost:1336",
5765 * 'add_interwiki_prefix' => false,
5766 * 'omit_bots' => true,
5768 * @example $wgRCFeeds['exampleirc'] = array(
5769 * 'formatter' => 'IRCColourfulRCFeedFormatter',
5770 * 'uri' => "udp://localhost:1338",
5771 * 'add_interwiki_prefix' => false,
5772 * 'omit_bots' => true,
5776 $wgRCFeeds = array();
5779 * Used by RecentChange::getEngine to find the correct engine to use for a given URI scheme.
5780 * Keys are scheme names, values are names of engine classes.
5782 $wgRCEngines = array(
5783 'redis' => 'RedisPubSubFeedEngine',
5784 'udp' => 'UDPRCFeedEngine',
5788 * Use RC Patrolling to check for vandalism
5790 $wgUseRCPatrol = true;
5793 * Use new page patrolling to check new pages on Special:Newpages
5795 $wgUseNPPatrol = true;
5798 * Log autopatrol actions to the log table
5800 $wgLogAutopatrol = true;
5803 * Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages
5808 * Set maximum number of results to return in syndication feeds (RSS, Atom) for
5809 * eg Recentchanges, Newpages.
5814 * _Minimum_ timeout for cached Recentchanges feed, in seconds.
5815 * A cached version will continue to be served out even if changes
5816 * are made, until this many seconds runs out since the last render.
5818 * If set to 0, feed caching is disabled. Use this for debugging only;
5819 * feed generation can be pretty slow with diffs.
5821 $wgFeedCacheTimeout = 60;
5824 * When generating Recentchanges RSS/Atom feed, diffs will not be generated for
5825 * pages larger than this size.
5827 $wgFeedDiffCutoff = 32768;
5830 * Override the site's default RSS/ATOM feed for recentchanges that appears on
5831 * every page. Some sites might have a different feed they'd like to promote
5832 * instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).
5833 * Should be a format as key (either 'rss' or 'atom') and an URL to the feed
5836 * Configure the 'atom' feed to http://example.com/somefeed.xml
5838 * $wgSiteFeed['atom'] = "http://example.com/somefeed.xml";
5841 $wgOverrideSiteFeed = array();
5844 * Available feeds objects.
5845 * Should probably only be defined when a page is syndicated ie when
5846 * $wgOut->isSyndicated() is true.
5848 $wgFeedClasses = array(
5850 'atom' => 'AtomFeed',
5854 * Which feed types should we provide by default? This can include 'rss',
5855 * 'atom', neither, or both.
5857 $wgAdvertisedFeedTypes = array( 'atom' );
5860 * Show watching users in recent changes, watchlist and page history views
5862 $wgRCShowWatchingUsers = false; # UPO
5865 * Show watching users in Page views
5867 $wgPageShowWatchingUsers = false;
5870 * Show the amount of changed characters in recent changes
5872 $wgRCShowChangedSize = true;
5875 * If the difference between the character counts of the text
5876 * before and after the edit is below that value, the value will be
5877 * highlighted on the RC page.
5879 $wgRCChangedSizeThreshold = 500;
5882 * Show "Updated (since my last visit)" marker in RC view, watchlist and history
5883 * view for watched pages with new changes
5885 $wgShowUpdatedMarker = true;
5888 * Disable links to talk pages of anonymous users (IPs) in listings on special
5889 * pages like page history, Special:Recentchanges, etc.
5891 $wgDisableAnonTalk = false;
5894 * Enable filtering of categories in Recentchanges
5896 $wgAllowCategorizedRecentChanges = false;
5899 * Allow filtering by change tag in recentchanges, history, etc
5900 * Has no effect if no tags are defined in valid_tag.
5902 $wgUseTagFilter = true;
5905 * If set to an integer, pages that are watched by this many users or more
5906 * will not require the unwatchedpages permission to view the number of
5911 $wgUnwatchedPageThreshold = false;
5914 * Flags (letter symbols) shown in recent changes and watchlist to indicate
5915 * certain types of edits.
5917 * To register a new one:
5919 * $wgRecentChangesFlags['flag'] => array(
5920 * // message for the letter displayed next to rows on changes lists
5921 * 'letter' => 'letter-msg',
5922 * // message for the tooltip of the letter
5923 * 'title' => 'tooltip-msg',
5924 * // optional (defaults to 'tooltip-msg'), message to use in the legend box
5925 * 'legend' => 'legend-msg',
5926 * // optional (defaults to 'flag'), CSS class to put on changes lists rows
5927 * 'class' => 'css-class',
5933 $wgRecentChangesFlags = array(
5935 'letter' => 'newpageletter',
5936 'title' => 'recentchanges-label-newpage',
5937 'legend' => 'recentchanges-legend-newpage',
5940 'letter' => 'minoreditletter',
5941 'title' => 'recentchanges-label-minor',
5942 'legend' => 'recentchanges-legend-minor',
5943 'class' => 'minoredit',
5946 'letter' => 'boteditletter',
5947 'title' => 'recentchanges-label-bot',
5948 'legend' => 'recentchanges-legend-bot',
5949 'class' => 'botedit',
5951 'unpatrolled' => array(
5952 'letter' => 'unpatrolledletter',
5953 'title' => 'recentchanges-label-unpatrolled',
5954 'legend' => 'recentchanges-legend-unpatrolled',
5958 /** @} */ # end RC/watchlist }
5960 /************************************************************************//**
5961 * @name Copyright and credits settings
5966 * Override for copyright metadata.
5968 * This is the name of the page containing information about the wiki's copyright status,
5969 * which will be added as a link in the footer if it is specified. It overrides
5970 * $wgRightsUrl if both are specified.
5972 $wgRightsPage = null;
5975 * Set this to specify an external URL containing details about the content license used on your
5977 * If $wgRightsPage is set then this setting is ignored.
5979 $wgRightsUrl = null;
5982 * If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the
5984 * If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name
5985 * of the page will also be used as the link if this variable is not set.
5987 $wgRightsText = null;
5990 * Override for copyright metadata.
5992 $wgRightsIcon = null;
5995 * Set this to some HTML to override the rights icon with an arbitrary logo
5996 * @deprecated since 1.18 Use $wgFooterIcons['copyright']['copyright']
5998 $wgCopyrightIcon = null;
6001 * Set this to true if you want detailed copyright information forms on Upload.
6003 $wgUseCopyrightUpload = false;
6006 * Set this to the number of authors that you want to be credited below an
6007 * article text. Set it to zero to hide the attribution block, and a negative
6008 * number (like -1) to show all authors. Note that this will require 2-3 extra
6009 * database hits, which can have a not insignificant impact on performance for
6015 * If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
6016 * Otherwise, link to a separate credits page.
6018 $wgShowCreditsIfMax = true;
6020 /** @} */ # end of copyright and credits settings }
6022 /************************************************************************//**
6023 * @name Import / Export
6028 * List of interwiki prefixes for wikis we'll accept as sources for
6029 * Special:Import (for sysops). Since complete page history can be imported,
6030 * these should be 'trusted'.
6032 * This can either be a regular array, or an associative map specifying
6033 * subprojects on the interwiki map of the target wiki, or a mix of the two,
6036 * $wgImportSources = array(
6037 * 'wikipedia' => array( 'cs', 'en', 'fr', 'zh' ),
6039 * 'wikia' => array( 'animanga', 'brickipedia', 'desserts' ),
6043 * If a user has the 'import' permission but not the 'importupload' permission,
6044 * they will only be able to run imports through this transwiki interface.
6046 $wgImportSources = array();
6049 * Optional default target namespace for interwiki imports.
6050 * Can use this to create an incoming "transwiki"-style queue.
6051 * Set to numeric key, not the name.
6053 * Users may override this in the Special:Import dialog.
6055 $wgImportTargetNamespace = null;
6058 * If set to false, disables the full-history option on Special:Export.
6059 * This is currently poorly optimized for long edit histories, so is
6060 * disabled on Wikimedia's sites.
6062 $wgExportAllowHistory = true;
6065 * If set nonzero, Special:Export requests for history of pages with
6066 * more revisions than this will be rejected. On some big sites things
6067 * could get bogged down by very very long pages.
6069 $wgExportMaxHistory = 0;
6072 * Return distinct author list (when not returning full history)
6074 $wgExportAllowListContributors = false;
6077 * If non-zero, Special:Export accepts a "pagelink-depth" parameter
6078 * up to this specified level, which will cause it to include all
6079 * pages linked to from the pages you specify. Since this number
6080 * can become *insanely large* and could easily break your wiki,
6081 * it's disabled by default for now.
6083 * @warning There's a HARD CODED limit of 5 levels of recursion to prevent a
6084 * crazy-big export from being done by someone setting the depth number too
6085 * high. In other words, last resort safety net.
6087 $wgExportMaxLinkDepth = 0;
6090 * Whether to allow the "export all pages in namespace" option
6092 $wgExportFromNamespaces = false;
6095 * Whether to allow exporting the entire wiki into a single file
6097 $wgExportAllowAll = false;
6099 /** @} */ # end of import/export }
6101 /*************************************************************************//**
6107 * A list of callback functions which are called once MediaWiki is fully
6110 $wgExtensionFunctions = array();
6113 * Extension messages files.
6115 * Associative array mapping extension name to the filename where messages can be
6116 * found. The file should contain variable assignments. Any of the variables
6117 * present in languages/messages/MessagesEn.php may be defined, but $messages
6118 * is the most common.
6120 * Variables defined in extensions will override conflicting variables defined
6123 * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
6124 * messages in JSON format and use $wgMessagesDirs. For setting other variables than
6125 * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
6126 * any entry having a key that also exists in $wgMessagesDirs will be ignored.
6128 * Extensions using the JSON message format can preserve backward compatibility with
6129 * earlier versions of MediaWiki by using a compatibility shim, such as one generated
6130 * by the generateJsonI18n.php maintenance script, listing it under the SAME key
6131 * as for the $wgMessagesDirs entry.
6135 * $wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
6138 $wgExtensionMessagesFiles = array();
6141 * Extension messages directories.
6143 * Associative array mapping extension name to the path of the directory where message files can
6144 * be found. The message files are expected to be JSON files named for their language code, e.g.
6145 * en.json, de.json, etc. Extensions with messages in multiple places may specify an array of
6146 * message directories.
6148 * @par Simple example:
6150 * $wgMessagesDirs['Example'] = __DIR__ . '/i18n';
6153 * @par Complex example:
6155 * $wgMessagesDirs['Example'] = array(
6156 * __DIR__ . '/lib/ve/i18n',
6157 * __DIR__ . '/lib/oojs-ui/i18n',
6158 * __DIR__ . '/i18n',
6163 $wgMessagesDirs = array(
6164 'core' => "$IP/languages/i18n",
6165 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
6169 * Array of files with list(s) of extension entry points to be used in
6170 * maintenance/mergeMessageFileList.php
6173 $wgExtensionEntryPointListFiles = array();
6176 * Parser output hooks.
6177 * This is an associative array where the key is an extension-defined tag
6178 * (typically the extension name), and the value is a PHP callback.
6179 * These will be called as an OutputPageParserOutput hook, if the relevant
6180 * tag has been registered with the parser output object.
6182 * Registration is done with $pout->addOutputHook( $tag, $data ).
6184 * The callback has the form:
6186 * function outputHook( $outputPage, $parserOutput, $data ) { ... }
6189 $wgParserOutputHooks = array();
6192 * Whether to include the NewPP limit report as a HTML comment
6194 $wgEnableParserLimitReporting = true;
6197 * List of valid skin names
6199 * The key should be the name in all lower case, the value should be a properly
6200 * cased name for the skin. This value will be prefixed with "Skin" to create
6201 * the class name of the skin to load. Use Skin::getSkinNames() as an accessor
6202 * if you wish to have access to the full list.
6204 $wgValidSkinNames = array();
6207 * Special page list.
6208 * See the top of SpecialPage.php for documentation.
6210 $wgSpecialPages = array();
6213 * Array mapping class names to filenames, for autoloading.
6215 $wgAutoloadClasses = array();
6218 * Switch controlling legacy case-insensitive classloading.
6219 * Do not disable if your wiki must support data created by PHP4, or by
6220 * MediaWiki 1.4 or earlier.
6222 $wgAutoloadAttemptLowercase = true;
6225 * An array of information about installed extensions keyed by their type.
6227 * All but 'name', 'path' and 'author' can be omitted.
6230 * $wgExtensionCredits[$type][] = array(
6231 * 'path' => __FILE__,
6232 * 'name' => 'Example extension',
6233 * 'namemsg' => 'exampleextension-name',
6234 * 'author' => array(
6237 * 'version' => '1.9.0',
6238 * 'url' => 'http://example.org/example-extension/',
6239 * 'descriptionmsg' => 'exampleextension-desc',
6240 * 'license-name' => 'GPL-2.0',
6244 * The extensions are listed on Special:Version. This page also looks for a file
6245 * named COPYING or LICENSE (optional .txt extension) and provides a link to
6246 * view said file. When the 'license-name' key is specified, this file is
6247 * interpreted as wikitext.
6249 * - $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam',
6250 * 'skin', 'api', or 'other', or any additional types as specified through the
6251 * ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
6253 * - name: Name of extension as an inline string instead of localizable message.
6254 * Do not omit this even if 'namemsg' is provided, as it is used to override
6255 * the path Special:Version uses to find extension's license info, and is
6256 * required for backwards-compatibility with MediaWiki 1.23 and older.
6258 * - namemsg (since MW 1.24): A message key for a message containing the
6259 * extension's name, if the name is localizable. (For example, skin names
6262 * - author: A string or an array of strings. Authors can be linked using
6263 * the regular wikitext link syntax. To have an internationalized version of
6264 * "and others" show, add an element "...". This element can also be linked,
6265 * for instance "[http://example ...]".
6267 * - descriptionmsg: A message key or an an array with message key and parameters:
6268 * `'descriptionmsg' => 'exampleextension-desc',`
6270 * - description: Description of extension as an inline string instead of
6271 * localizable message (omit in favour of 'descriptionmsg').
6273 * - license-name: Short name of the license (used as label for the link), such
6274 * as "GPL-2.0" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
6276 $wgExtensionCredits = array();
6279 * Authentication plugin.
6280 * @var $wgAuth AuthPlugin
6285 * Global list of hooks.
6287 * The key is one of the events made available by MediaWiki, you can find
6288 * a description for most of them in docs/hooks.txt. The array is used
6289 * internally by Hook:run().
6291 * The value can be one of:
6293 * - A function name:
6295 * $wgHooks['event_name'][] = $function;
6297 * - A function with some data:
6299 * $wgHooks['event_name'][] = array( $function, $data );
6301 * - A an object method:
6303 * $wgHooks['event_name'][] = array( $object, 'method' );
6307 * $wgHooks['event_name'][] = function ( $hookParam ) {
6308 * // Handler code goes here.
6312 * @warning You should always append to an event array or you will end up
6313 * deleting a previous registered hook.
6315 * @warning Hook handlers should be registered at file scope. Registering
6316 * handlers after file scope can lead to unexpected results due to caching.
6321 * Maps jobs to their handling classes; extensions
6322 * can add to this to provide custom jobs
6324 $wgJobClasses = array(
6325 'refreshLinks' => 'RefreshLinksJob',
6326 'refreshLinks2' => 'RefreshLinksJob2', // b/c
6327 'htmlCacheUpdate' => 'HTMLCacheUpdateJob',
6328 'sendMail' => 'EmaillingJob',
6329 'enotifNotify' => 'EnotifNotifyJob',
6330 'fixDoubleRedirect' => 'DoubleRedirectJob',
6331 'uploadFromUrl' => 'UploadFromUrlJob',
6332 'AssembleUploadChunks' => 'AssembleUploadChunksJob',
6333 'PublishStashedFile' => 'PublishStashedFileJob',
6334 'ThumbnailRender' => 'ThumbnailRenderJob',
6339 * Jobs that must be explicitly requested, i.e. aren't run by job runners unless
6340 * special flags are set. The values here are keys of $wgJobClasses.
6343 * - Very long-running jobs.
6344 * - Jobs that you would never want to run as part of a page rendering request.
6345 * - Jobs that you want to run on specialized machines ( like transcoding, or a particular
6346 * machine on your cluster has 'outside' web access you could restrict uploadFromUrl )
6347 * These settings should be global to all wikis.
6349 $wgJobTypesExcludedFromDefaultQueue = array( 'AssembleUploadChunks', 'PublishStashedFile' );
6352 * Map of job types to how many job "work items" should be run per second
6353 * on each job runner process. The meaning of "work items" varies per job,
6354 * but typically would be something like "pages to update". A single job
6355 * may have a variable number of work items, as is the case with batch jobs.
6356 * This is used by runJobs.php and not jobs run via $wgJobRunRate.
6357 * These settings should be global to all wikis.
6360 $wgJobBackoffThrottling = array();
6363 * Map of job types to configuration arrays.
6364 * This determines which queue class and storage system is used for each job type.
6365 * Job types that do not have explicit configuration will use the 'default' config.
6366 * These settings should be global to all wikis.
6368 $wgJobTypeConf = array(
6369 'default' => array( 'class' => 'JobQueueDB', 'order' => 'random' ),
6373 * Which aggregator to use for tracking which queues have jobs.
6374 * These settings should be global to all wikis.
6376 $wgJobQueueAggregator = array(
6377 'class' => 'JobQueueAggregatorMemc'
6381 * Additional functions to be performed with updateSpecialPages.
6382 * Expensive Querypages are already updated.
6384 $wgSpecialPageCacheUpdates = array(
6385 'Statistics' => array( 'SiteStatsUpdate', 'cacheUpdate' ),
6386 'Activeusers' => array( 'SpecialActiveUsers', 'cacheUpdate' ),
6390 * Hooks that are used for outputting exceptions. Format is:
6391 * $wgExceptionHooks[] = $funcname
6393 * $wgExceptionHooks[] = array( $class, $funcname )
6394 * Hooks should return strings or false
6396 $wgExceptionHooks = array();
6399 * Page property link table invalidation lists. When a page property
6400 * changes, this may require other link tables to be updated (eg
6401 * adding __HIDDENCAT__ means the hiddencat tracking category will
6402 * have been added, so the categorylinks table needs to be rebuilt).
6403 * This array can be added to by extensions.
6405 $wgPagePropLinkInvalidations = array(
6406 'hiddencat' => 'categorylinks',
6409 /** @} */ # End extensions }
6411 /*************************************************************************//**
6417 * Use experimental, DMOZ-like category browser
6419 $wgUseCategoryBrowser = false;
6422 * On category pages, show thumbnail gallery for images belonging to that
6423 * category instead of listing them as articles.
6425 $wgCategoryMagicGallery = true;
6428 * Paging limit for categories
6430 $wgCategoryPagingLimit = 200;
6433 * Specify how category names should be sorted, when listed on a category page.
6434 * A sorting scheme is also known as a collation.
6436 * Available values are:
6438 * - uppercase: Converts the category name to upper case, and sorts by that.
6440 * - identity: Does no conversion. Sorts by binary value of the string.
6442 * - uca-default: Provides access to the Unicode Collation Algorithm with
6443 * the default element table. This is a compromise collation which sorts
6444 * all languages in a mediocre way. However, it is better than "uppercase".
6446 * To use the uca-default collation, you must have PHP's intl extension
6447 * installed. See http://php.net/manual/en/intl.setup.php . The details of the
6448 * resulting collation will depend on the version of ICU installed on the
6451 * After you change this, you must run maintenance/updateCollation.php to fix
6452 * the sort keys in the database.
6454 * Extensions can define there own collations by subclassing Collation
6455 * and using the Collation::factory hook.
6457 $wgCategoryCollation = 'uppercase';
6459 /** @} */ # End categories }
6461 /*************************************************************************//**
6467 * The logging system has two levels: an event type, which describes the
6468 * general category and can be viewed as a named subset of all logs; and
6469 * an action, which is a specific kind of event that can exist in that
6472 $wgLogTypes = array(
6487 * This restricts log access to those who have a certain right
6488 * Users without this will not see it in the option menu and can not view it
6489 * Restricted logs are not added to recent changes
6490 * Logs should remain non-transcludable
6491 * Format: logtype => permissiontype
6493 $wgLogRestrictions = array(
6494 'suppress' => 'suppressionlog'
6498 * Show/hide links on Special:Log will be shown for these log types.
6500 * This is associative array of log type => boolean "hide by default"
6502 * See $wgLogTypes for a list of available log types.
6506 * $wgFilterLogTypes = array(
6508 * 'import' => false,
6512 * Will display show/hide links for the move and import logs. Move logs will be
6513 * hidden by default unless the link is clicked. Import logs will be shown by
6514 * default, and hidden when the link is clicked.
6516 * A message of the form log-show-hide-[type] should be added, and will be used
6517 * for the link text.
6519 $wgFilterLogTypes = array(
6524 * Lists the message key string for each log type. The localized messages
6525 * will be listed in the user interface.
6527 * Extensions with custom log types may add to this array.
6529 * @since 1.19, if you follow the naming convention log-name-TYPE,
6530 * where TYPE is your log type, yoy don't need to use this array.
6532 $wgLogNames = array(
6533 '' => 'all-logs-page',
6534 'block' => 'blocklogpage',
6535 'protect' => 'protectlogpage',
6536 'rights' => 'rightslog',
6537 'delete' => 'dellogpage',
6538 'upload' => 'uploadlogpage',
6539 'move' => 'movelogpage',
6540 'import' => 'importlogpage',
6541 'patrol' => 'patrol-log-page',
6542 'merge' => 'mergelog',
6543 'suppress' => 'suppressionlog',
6547 * Lists the message key string for descriptive text to be shown at the
6548 * top of each log type.
6550 * Extensions with custom log types may add to this array.
6552 * @since 1.19, if you follow the naming convention log-description-TYPE,
6553 * where TYPE is your log type, yoy don't need to use this array.
6555 $wgLogHeaders = array(
6556 '' => 'alllogstext',
6557 'block' => 'blocklogtext',
6558 'protect' => 'protectlogtext',
6559 'rights' => 'rightslogtext',
6560 'delete' => 'dellogpagetext',
6561 'upload' => 'uploadlogpagetext',
6562 'move' => 'movelogpagetext',
6563 'import' => 'importlogpagetext',
6564 'patrol' => 'patrol-log-header',
6565 'merge' => 'mergelogpagetext',
6566 'suppress' => 'suppressionlogtext',
6570 * Lists the message key string for formatting individual events of each
6571 * type and action when listed in the logs.
6573 * Extensions with custom log types may add to this array.
6575 $wgLogActions = array(
6576 'block/block' => 'blocklogentry',
6577 'block/unblock' => 'unblocklogentry',
6578 'block/reblock' => 'reblock-logentry',
6579 'protect/protect' => 'protectedarticle',
6580 'protect/modify' => 'modifiedarticleprotection',
6581 'protect/unprotect' => 'unprotectedarticle',
6582 'protect/move_prot' => 'movedarticleprotection',
6583 'import/upload' => 'import-logentry-upload',
6584 'import/interwiki' => 'import-logentry-interwiki',
6585 'merge/merge' => 'pagemerge-logentry',
6586 'suppress/block' => 'blocklogentry',
6587 'suppress/reblock' => 'reblock-logentry',
6591 * The same as above, but here values are names of functions,
6593 * @see LogPage::actionText
6596 $wgLogActionsHandlers = array(
6597 'move/move' => 'MoveLogFormatter',
6598 'move/move_redir' => 'MoveLogFormatter',
6599 'delete/delete' => 'DeleteLogFormatter',
6600 'delete/restore' => 'DeleteLogFormatter',
6601 'delete/revision' => 'DeleteLogFormatter',
6602 'delete/event' => 'DeleteLogFormatter',
6603 'suppress/revision' => 'DeleteLogFormatter',
6604 'suppress/event' => 'DeleteLogFormatter',
6605 'suppress/delete' => 'DeleteLogFormatter',
6606 'patrol/patrol' => 'PatrolLogFormatter',
6607 'rights/rights' => 'RightsLogFormatter',
6608 'rights/autopromote' => 'RightsLogFormatter',
6609 'upload/upload' => 'LogFormatter',
6610 'upload/overwrite' => 'LogFormatter',
6611 'upload/revert' => 'LogFormatter',
6615 * Maintain a log of newusers at Log/newusers?
6617 $wgNewUserLog = true;
6619 /** @} */ # end logging }
6621 /*************************************************************************//**
6622 * @name Special pages (general and miscellaneous)
6627 * Allow special page inclusions such as {{Special:Allpages}}
6629 $wgAllowSpecialInclusion = true;
6632 * Set this to an array of special page names to prevent
6633 * maintenance/updateSpecialPages.php from updating those pages.
6635 $wgDisableQueryPageUpdate = false;
6638 * List of special pages, followed by what subtitle they should go under
6639 * at Special:SpecialPages
6641 * @deprecated since 1.21 Override SpecialPage::getGroupName instead
6643 $wgSpecialPageGroups = array();
6646 * On Special:Unusedimages, consider images "used", if they are put
6647 * into a category. Default (false) is not to count those as used.
6649 $wgCountCategorizedImagesAsUsed = false;
6652 * Maximum number of links to a redirect page listed on
6653 * Special:Whatlinkshere/RedirectDestination
6655 $wgMaxRedirectLinksRetrieved = 500;
6657 /** @} */ # end special pages }
6659 /*************************************************************************//**
6665 * Array of allowed values for the "title=foo&action=<action>" parameter. Syntax is:
6666 * 'foo' => 'ClassName' Load the specified class which subclasses Action
6667 * 'foo' => true Load the class FooAction which subclasses Action
6668 * If something is specified in the getActionOverrides()
6669 * of the relevant Page object it will be used
6670 * instead of the default class.
6671 * 'foo' => false The action is disabled; show an error message
6672 * Unsetting core actions will probably cause things to complain loudly.
6680 'markpatrolled' => true,
6686 'revisiondelete' => true,
6689 'unprotect' => true,
6695 /** @} */ # end actions }
6697 /*************************************************************************//**
6698 * @name Robot (search engine crawler) policy
6699 * See also $wgNoFollowLinks.
6704 * Default robot policy. The default policy is to encourage indexing and fol-
6705 * lowing of links. It may be overridden on a per-namespace and/or per-page
6708 $wgDefaultRobotPolicy = 'index,follow';
6711 * Robot policies per namespaces. The default policy is given above, the array
6712 * is made of namespace constants as defined in includes/Defines.php. You can-
6713 * not specify a different default policy for NS_SPECIAL: it is always noindex,
6714 * nofollow. This is because a number of special pages (e.g., ListPages) have
6715 * many permutations of options that display the same data under redundant
6716 * URLs, so search engine spiders risk getting lost in a maze of twisty special
6717 * pages, all alike, and never reaching your actual content.
6721 * $wgNamespaceRobotPolicies = array( NS_TALK => 'noindex' );
6724 $wgNamespaceRobotPolicies = array();
6727 * Robot policies per article. These override the per-namespace robot policies.
6728 * Must be in the form of an array where the key part is a properly canonicalised
6729 * text form title and the value is a robot policy.
6733 * $wgArticleRobotPolicies = array(
6734 * 'Main Page' => 'noindex,follow',
6735 * 'User:Bob' => 'index,follow',
6739 * @par Example that DOES NOT WORK because the names are not canonical text
6742 * $wgArticleRobotPolicies = array(
6743 * # Underscore, not space!
6744 * 'Main_Page' => 'noindex,follow',
6745 * # "Project", not the actual project name!
6746 * 'Project:X' => 'index,follow',
6747 * # Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
6748 * 'abc' => 'noindex,nofollow'
6752 $wgArticleRobotPolicies = array();
6755 * An array of namespace keys in which the __INDEX__/__NOINDEX__ magic words
6756 * will not function, so users can't decide whether pages in that namespace are
6757 * indexed by search engines. If set to null, default to $wgContentNamespaces.
6761 * $wgExemptFromUserRobotsControl = array( NS_MAIN, NS_TALK, NS_PROJECT );
6764 $wgExemptFromUserRobotsControl = null;
6766 /** @} */ # End robot policy }
6768 /************************************************************************//**
6769 * @name AJAX and API
6770 * Note: The AJAX entry point which this section refers to is gradually being
6771 * replaced by the API entry point, api.php. They are essentially equivalent.
6772 * Both of them are used for dynamic client-side features, via XHR.
6777 * Enable the MediaWiki API for convenient access to
6778 * machine-readable data via api.php
6780 * See https://www.mediawiki.org/wiki/API
6782 $wgEnableAPI = true;
6785 * Allow the API to be used to perform write operations
6786 * (page edits, rollback, etc.) when an authorised user
6789 $wgEnableWriteAPI = true;
6793 * WARNING: SECURITY THREAT - debug use only
6795 * Disables many security checks in the API for debugging purposes.
6796 * This flag should never be used on the production servers, as it introduces
6797 * a number of potential security holes. Even when enabled, the validation
6798 * will still be performed, but instead of failing, API will return a warning.
6799 * Also, there will always be a warning notifying that this flag is set.
6800 * At this point, the flag allows GET requests to go through for modules
6805 $wgDebugAPI = false;
6808 * API module extensions.
6810 * Associative array mapping module name to modules specs;
6811 * Each module spec is an associative array containing at least
6812 * the 'class' key for the module's class, and optionally a
6813 * 'factory' key for the factory function to use for the module.
6815 * That factory function will be called with two parameters,
6816 * the parent module (an instance of ApiBase, usually ApiMain)
6817 * and the name the module was registered under. The return
6818 * value must be an instance of the class given in the 'class'
6821 * For backward compatibility, the module spec may also be a
6822 * simple string containing the module's class name. In that
6823 * case, the class' constructor will be called with the parent
6824 * module and module name as parameters, as described above.
6826 * Examples for registering API modules:
6829 * $wgAPIModules['foo'] = 'ApiFoo';
6830 * $wgAPIModules['bar'] = array(
6831 * 'class' => 'ApiBar',
6832 * 'factory' => function( $main, $name ) { ... }
6834 * $wgAPIModules['xyzzy'] = array(
6835 * 'class' => 'ApiXyzzy',
6836 * 'factory' => array( 'XyzzyFactory', 'newApiModule' )
6840 * Extension modules may override the core modules.
6841 * See ApiMain::$Modules for a list of the core modules.
6843 $wgAPIModules = array();
6846 * API format module extensions.
6847 * Associative array mapping format module name to module specs (see $wgAPIModules).
6848 * Extension modules may override the core modules.
6850 * See ApiMain::$Formats for a list of the core format modules.
6852 $wgAPIFormatModules = array();
6855 * API Query meta module extensions.
6856 * Associative array mapping meta module name to module specs (see $wgAPIModules).
6857 * Extension modules may override the core modules.
6859 * See ApiQuery::$QueryMetaModules for a list of the core meta modules.
6861 $wgAPIMetaModules = array();
6864 * API Query prop module extensions.
6865 * Associative array mapping prop module name to module specs (see $wgAPIModules).
6866 * Extension modules may override the core modules.
6868 * See ApiQuery::$QueryPropModules for a list of the core prop modules.
6870 $wgAPIPropModules = array();
6873 * API Query list module extensions.
6874 * Associative array mapping list module name to module specs (see $wgAPIModules).
6875 * Extension modules may override the core modules.
6877 * See ApiQuery::$QueryListModules for a list of the core list modules.
6879 $wgAPIListModules = array();
6882 * This variable is ignored. To add your module to the API, please add it to $wgAPI*Modules
6883 * @deprecated since 1.21
6885 $wgAPIGeneratorModules = array();
6888 * Maximum amount of rows to scan in a DB query in the API
6889 * The default value is generally fine
6891 $wgAPIMaxDBRows = 5000;
6894 * The maximum size (in bytes) of an API result.
6895 * @warning Do not set this lower than $wgMaxArticleSize*1024
6897 $wgAPIMaxResultSize = 8388608;
6900 * The maximum number of uncached diffs that can be retrieved in one API
6901 * request. Set this to 0 to disable API diffs altogether
6903 $wgAPIMaxUncachedDiffs = 1;
6906 * Log file or URL (TCP or UDP) to log API requests to, or false to disable
6907 * API request logging
6909 $wgAPIRequestLog = false;
6912 * Set the timeout for the API help text cache. If set to 0, caching disabled
6914 $wgAPICacheHelpTimeout = 60 * 60;
6917 * The ApiQueryQueryPages module should skip pages that are redundant to true
6920 $wgAPIUselessQueryPages = array(
6921 'MIMEsearch', // aiprop=mime
6922 'LinkSearch', // list=exturlusage
6923 'FileDuplicateSearch', // prop=duplicatefiles
6927 * Enable AJAX framework
6932 * List of Ajax-callable functions.
6933 * Extensions acting as Ajax callbacks must register here
6935 $wgAjaxExportList = array();
6938 * Enable watching/unwatching pages using AJAX.
6939 * Requires $wgUseAjax to be true too.
6941 $wgAjaxWatch = true;
6944 * Enable AJAX check for file overwrite, pre-upload
6946 $wgAjaxUploadDestCheck = true;
6949 * Enable previewing licences via AJAX. Also requires $wgEnableAPI to be true.
6951 $wgAjaxLicensePreview = true;
6954 * Settings for incoming cross-site AJAX requests:
6955 * Newer browsers support cross-site AJAX when the target resource allows requests
6956 * from the origin domain by the Access-Control-Allow-Origin header.
6957 * This is currently only used by the API (requests to api.php)
6958 * $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
6960 * - '*' matches any number of characters
6961 * - '?' matches any 1 character
6965 * $wgCrossSiteAJAXdomains = array(
6966 * 'www.mediawiki.org',
6967 * '*.wikipedia.org',
6968 * '*.wikimedia.org',
6969 * '*.wiktionary.org',
6973 $wgCrossSiteAJAXdomains = array();
6976 * Domains that should not be allowed to make AJAX requests,
6977 * even if they match one of the domains allowed by $wgCrossSiteAJAXdomains
6978 * Uses the same syntax as $wgCrossSiteAJAXdomains
6980 $wgCrossSiteAJAXdomainExceptions = array();
6982 /** @} */ # End AJAX and API }
6984 /************************************************************************//**
6985 * @name Shell and process control
6990 * Maximum amount of virtual memory available to shell processes under linux, in KB.
6992 $wgMaxShellMemory = 307200;
6995 * Maximum file size created by shell processes under linux, in KB
6996 * ImageMagick convert for example can be fairly hungry for scratch space
6998 $wgMaxShellFileSize = 102400;
7001 * Maximum CPU time in seconds for shell processes under Linux
7003 $wgMaxShellTime = 180;
7006 * Maximum wall clock time (i.e. real time, of the kind the clock on the wall
7007 * would measure) in seconds for shell processes under Linux
7009 $wgMaxShellWallClockTime = 180;
7012 * Under Linux: a cgroup directory used to constrain memory usage of shell
7013 * commands. The directory must be writable by the user which runs MediaWiki.
7015 * If specified, this is used instead of ulimit, which is inaccurate, and
7016 * causes malloc() to return NULL, which exposes bugs in C applications, making
7017 * them segfault or deadlock.
7019 * A wrapper script will create a cgroup for each shell command that runs, as
7020 * a subgroup of the specified cgroup. If the memory limit is exceeded, the
7021 * kernel will send a SIGKILL signal to a process in the subgroup.
7025 * mkdir -p /sys/fs/cgroup/memory/mediawiki
7026 * mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
7027 * echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php
7030 * The reliability of cgroup cleanup can be improved by installing a
7031 * notify_on_release script in the root cgroup, see e.g.
7032 * https://gerrit.wikimedia.org/r/#/c/40784
7034 $wgShellCgroup = false;
7037 * Executable path of the PHP cli binary (php/php5). Should be set up on install.
7039 $wgPhpCli = '/usr/bin/php';
7042 * Locale for LC_CTYPE, to work around http://bugs.php.net/bug.php?id=45132
7043 * For Unix-like operating systems, set this to to a locale that has a UTF-8
7044 * character set. Only the character set is relevant.
7046 $wgShellLocale = 'en_US.utf8';
7048 /** @} */ # End shell }
7050 /************************************************************************//**
7056 * Timeout for HTTP requests done internally, in seconds.
7058 $wgHTTPTimeout = 25;
7061 * Timeout for Asynchronous (background) HTTP requests, in seconds.
7063 $wgAsyncHTTPTimeout = 25;
7066 * Proxy to use for CURL requests.
7068 $wgHTTPProxy = false;
7071 * Timeout for connections done internally (in seconds)
7072 * Only works for curl
7074 $wgHTTPConnectTimeout = 5e0
;
7076 /** @} */ # End HTTP client }
7078 /************************************************************************//**
7080 * See also $wgEnotifUseJobQ.
7085 * Number of jobs to perform per request. May be less than one in which case
7086 * jobs are performed probabalistically. If this is zero, jobs will not be done
7087 * during ordinary apache requests. In this case, maintenance/runJobs.php should
7088 * be run periodically.
7093 * When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process
7094 * to handle the job execution, instead of blocking the request until the job
7095 * execution finishes.
7098 $wgRunJobsAsync = true;
7101 * Number of rows to update per job
7103 $wgUpdateRowsPerJob = 500;
7106 * Number of rows to update per query
7108 $wgUpdateRowsPerQuery = 100;
7110 /** @} */ # End job queue }
7112 /************************************************************************//**
7113 * @name Miscellaneous
7118 * Name of the external diff engine to use
7120 $wgExternalDiffEngine = false;
7123 * Disable redirects to special pages and interwiki redirects, which use a 302
7124 * and have no "redirected from" link.
7126 * @note This is only for articles with #REDIRECT in them. URL's containing a
7127 * local interwiki prefix (or a non-canonical special page name) are still hard
7128 * redirected regardless of this setting.
7130 $wgDisableHardRedirects = false;
7133 * LinkHolderArray batch size
7136 $wgLinkHolderBatchSize = 1000;
7139 * By default MediaWiki does not register links pointing to same server in
7140 * externallinks dataset, use this value to override:
7142 $wgRegisterInternalExternals = false;
7145 * Maximum number of pages to move at once when moving subpages with a page.
7147 $wgMaximumMovedPages = 100;
7150 * Fix double redirects after a page move.
7151 * Tends to conflict with page move vandalism, use only on a private wiki.
7153 $wgFixDoubleRedirects = false;
7156 * Allow redirection to another page when a user logs in.
7157 * To enable, set to a string like 'Main Page'
7159 $wgRedirectOnLogin = null;
7162 * Configuration for processing pool control, for use in high-traffic wikis.
7163 * An implementation is provided in the PoolCounter extension.
7165 * This configuration array maps pool types to an associative array. The only
7166 * defined key in the associative array is "class", which gives the class name.
7167 * The remaining elements are passed through to the class as constructor
7172 * $wgPoolCounterConf = array( 'ArticleView' => array(
7173 * 'class' => 'PoolCounter_Client',
7174 * 'timeout' => 15, // wait timeout in seconds
7175 * 'workers' => 5, // maximum number of active threads in each pool
7176 * 'maxqueue' => 50, // maximum number of total threads in each pool
7177 * ... any extension-specific options...
7181 $wgPoolCounterConf = null;
7184 * To disable file delete/restore temporarily
7186 $wgUploadMaintenance = false;
7189 * Associative array mapping namespace IDs to the name of the content model pages in that namespace
7190 * should have by default (use the CONTENT_MODEL_XXX constants). If no special content type is
7191 * defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT
7192 * (except for the special case of JS and CS pages).
7196 $wgNamespaceContentModels = array();
7199 * How to react if a plain text version of a non-text Content object is requested using
7200 * ContentHandler::getContentText():
7202 * * 'ignore': return null
7203 * * 'fail': throw an MWException
7204 * * 'serialize': serialize to default format
7208 $wgContentHandlerTextFallback = 'ignore';
7211 * Set to false to disable use of the database fields introduced by the ContentHandler facility.
7212 * This way, the ContentHandler facility can be used without any additional information in the
7213 * database. A page's content model is then derived solely from the page's title. This however
7214 * means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break
7215 * the page and/or make the content inaccessible. This also means that pages can not be moved to
7216 * a title that would default to a different content model.
7218 * Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content
7219 * handling is less robust and less flexible.
7223 $wgContentHandlerUseDB = true;
7226 * Determines which types of text are parsed as wikitext. This does not imply that these kinds
7227 * of texts are also rendered as wikitext, it only means that links, magic words, etc will have
7228 * the effect on the database they would have on a wikitext page.
7230 * @todo On the long run, it would be nice to put categories etc into a separate structure,
7231 * or at least parse only the contents of comments in the scripts.
7235 $wgTextModelsToParse = array(
7236 CONTENT_MODEL_WIKITEXT
, // Just for completeness, wikitext will always be parsed.
7237 CONTENT_MODEL_JAVASCRIPT
, // Make categories etc work, people put them into comments.
7238 CONTENT_MODEL_CSS
, // Make categories etc work, people put them into comments.
7242 * Whether the user must enter their password to change their e-mail address
7246 $wgRequirePasswordforEmailChange = true;
7249 * Register handlers for specific types of sites.
7253 $wgSiteTypes = array(
7254 'mediawiki' => 'MediaWikiSite',
7258 * Whether the page_props table has a pp_sortkey column. Set to false in case
7259 * the respective database schema change was not applied.
7262 $wgPagePropsHaveSortkey = true;
7265 * Port where you have HTTPS running
7266 * Supports HTTPS on non-standard ports
7273 * Secret and algorithm for hmac-based key derivation function (fast,
7274 * cryptographically secure random numbers).
7275 * This should be set in LocalSettings.php, otherwise wgSecretKey will
7279 $wgHKDFSecret = false;
7280 $wgHKDFAlgorithm = 'sha256';
7283 * Enable page language feature
7284 * Allows setting page language in database
7288 $wgPageLanguageUseDB = false;
7291 * Enable use of the *_namespace fields of the pagelinks, redirect, and templatelinks tables.
7292 * Set this only if the fields are fully populated. This may be removed in 1.25.
7296 $wgUseLinkNamespaceDBFields = true;
7299 * For really cool vim folding this needs to be at the end:
7300 * vim: foldmarker=@{,@} foldmethod=marker